Glossary Entries

Use

Glossary topics are used to define specialized terms, acronyms, or jargon. These entries help ensure consistency across teams, translations, and publications. They are particularly useful in complex domains (e.g., finance, healthcare, software development) where term usage can vary widely.

User Intent

"What does this term mean in this context?"

Common Tags

• <glossentry>: Root element.
• <glossterm>: The term being defined.
• <glossdef>: Definition of the term.
• <glossBody>: Optional additional explanation or related terms.
• <acronym>: Full form of abbreviated terms.
• <synonyms>: Alternative terms with the same meaning.

Writing Best Practices

• Start definitions with the part of speech and category.
• Avoid using the term within its own definition.
• Keep definitions concise but complete.
• Use examples to clarify abstract concepts.
• Cross-reference related terms.
• Build glossary entries incrementally: when you find yourself explaining the same term repeatedly, create a glossary entry and link to it instead.

Sample XML Code

<glossentry id="api">
  <glossterm>API</glossterm>
  <glossdef>
    <p>An Application Programming Interface enables systems to communicate with each other.</p>
  </glossdef>
</glossentry>