Glossary Item

...

Document Properties Marker

override	false

Short Description Glossary items are part of the domain glossary for the project. Glossaries support the team to use terms of the domain consistently in conversations and documentation.

Doctype doctype hide

Name Glossary Item

ID glossary-item

Suite Core

Set Core hide

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Documentation Type

Name List

doctype	doctype-type
render-no-hits-as-blank	true
names	Q1 - Process
property	Documentation Type

Tags

Tag List

names	Core, Project

Iteration


value	focused

hide

Sort Key hide

...

Section

title	Properties

Transclusion

document	Note Box referencing common Document Properties
ids	Box

Section

title	Type

Allows to organize glossary items by a doctype specific type using Glossary Item Type.

Section

title	Abbreviation

A abbreviation commonly used for the term. Defaults to the short name.

Section

title	Linguistic Information

Provide linguistic information, such as genus or pronunciation, for the term.

Section

title	Word Type

Version Box

until	11.0

Replaced by the Linguistic Information property.

Helps to categorize a term to be a noun (concept) or a verb (process-word).

Note Box
You may replace the selection macro with the Name List Macro and add other or additional word types.

Section

level	2
title	Domain

Version Box

until	11.0

Replaced by the Relation property.

State the domain within which the term is used. Terms may be part of the problem or the solution domain. In complex situations terms may be associated with a specific area of a problem domain.

This property allows to group terms by their domains. Please note that the term should be unique within the project independent of its domain to avoid confusion.

The name of the domain may link to a document that describes this domain (and maybe list all of its terms). This document may by itself be of type glossary item. You may also choose to use the Name List Macro to reference to these documents that describe the domain.

Section

title	Relation

Version Box

since	11.1

Since version 11.1 Domain has been removed and replaced by the relation. The relation existed prior to version 11.1 but did not provide its own doctype.

Within a given domain terms may be related. This relation may be defined by a relation name.

The name of the relation may link to a document that describes this relation (and maybe list all of its terms). You may also choose to use the Name List Macro to reference to these documents that describe the domain.

Section

title	Related Terms

Version Box

since	11.1

Since version 11.1 used to pick closely related terms.

List terms with references to other closely related terms in this glossary.

Section

title	Sections

Section

title	Description

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

title	Specializations

Version Box

until	11.0

Removed to simplify the usage of glossary items.

Specializations narrow the generalized definition by differentiation.

This section lists subdocuments of this doctype.

Section

title	Associated Terms

Version Box

until	11.0

Removed to simplify the usage of glossary items.

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

title	Related Terms

List of Related Terms

Automatically lists items that are associated to this term. The terms are picked from the Related Terms property

Automatically collects related terms by the relation property.

All terms are listed that share this term's relation. If the list gets to long and unspecific, specialize the relation

.

Section

title	Translations

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

title	Antonyms

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

title	Synonyms

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

title	Differences 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

title	Deprecated 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

title	ID 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 analyzers. If such rules are applied, refer to them in the resource section of this document.

Transclusion

document	Document Sections
ids	standard-sections-bottom

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 5

New Version 6

Key

About

Keep up-to-date!

Powered by