Glossary Term Block
Define terminology with definitions, acronyms, related terms, and categories for consistent documentation vocabulary.
The Glossary Term block provides a structured way to define terminology used throughout your documentation. It supports acronyms, definitions, related terms, and categorisation, helping maintain a consistent vocabulary across teams and documents.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Term | Yes | The word or phrase being defined |
| Definition | No | Clear explanation of the term |
| Acronym | No | Abbreviated form if applicable (e.g., API, REST) |
| Related Terms | No | Other terms that relate to this concept |
| Category | No | Grouping for organisation (e.g., Architecture, Security) |
Example: Technical Term
A common architectural pattern with related concepts.
Example: Acronym Definition
Defining an industry-standard acronym.
Example: Security Term
A security concept with categorisation.