Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleSections
Section
level2
titleDescription

Define the term within its domain.

Note Box

While most document types use the description sections to inform the reader about what to expect from the document, the glossary item actually has the definition of the term as its description.

Also note that this section does not demand a formal definition. So it is allowed to come as close as possible to define the term in the current context of the project (recognition rule). Projects sometimes need to define a working hypothesis for a term. Therefore it is also ok to just give a rough sketch defined by the team and the domain experts.

For more information on this topic, please refer to Software Requirements & Specification by Michael A. Jackson.

To describe a term define its scope and differentiate it by a span. The span constricts the applicability of the term within its domain and scope.

While the domain is explicitly stated, the scope is not. The scope may be identical to the domain or some form of subdomain.

Section
level2
titleSpecializations

Specializations narrow the generalized definition by differentiation.

This section lists subdocuments of this doctype.

Section
titleAssociated Terms

Collects items that are associated with this term. To be collected the associated term needs to have a relation that matches this term's name.

While related terms are on the same level and child documents represent specializations, associated terms are those that are part or a property of the term and describe it.

Note Box

This section is available since version 6.2.0.

Section
level2
titleRelated Terms

This section collects Collects related terms by the relation property.

All terms are listed that share this term's relation.

Section
level2
titleTranslations

List translations of the term in other languages. These translations must not be used in the documents, but may help translators of technical documents. Usually you may add a two column table here, with the name of the locale (ISO 639 / ISO 3166 code) as the key and the translation of the term as a value.

Section
level2
titleAntonyms

List terms that mean the opposite of the defined term.

This supports to relate the term to other terms in the domain. The table of antonyms is usually two columns: the key in the first column is the antonym term, the second column contains an optional note.

Section
level2
titleSynonyms

List terms that are different words for the same concept.

Synonyms must not be used in the documentation to avoid confusion. The table of synonyms has usually two columns: the key in the first column is the synonym term, the second column contains an optional note that explains, why this term is not used.

Section
level2
titleDifferences to

Explain the differences to other terms that may be confused with the defined term. This supports to relate the term to other terms in the domain. Use a two-column table with the first column specifying the term and the second column explaining the differences to the defined term and notes.

Section
level2
titleDeprecated Forms

List the forms of the word that have been deprecated.

Add those words that have formerly been used for the term, but are now discouraged.List the deprecated term (first column) and the reason why it is deprecated (second column) in a table.

Section
level2
titleID Parts

Describe how the term is used in identifiers of programming languages (class names, method names, etc.) or other text files.

This supports to name these constructs consistently throughout the project. The parts are only explicitly defined in the wiki, if they cannot be generated automatically. The rules may be checked by static analysers. If such rules are applied, refer to them in the resource section of this document.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...