Avoid adding new dictionary entries without documenting their purpose and rationale.

< 1 min read

Impact Area

Manageability

Severity

Low

Affected Element

Dictionary (DICT)

Rule number

SN-AVOID-UNDOCUMENTED-DICT-ENTRY

Impact #

Adding new dictionary entries to an instance without documenting their intended use and the rationale for creating them in the comments field hinders the manageability of the instance in the medium and long term, as the intent of the field may not be obvious to future developers and administrators of the instance from the field’s name and label alone.