Glossary feature overview

Does your documentation use common terms, acronyms, or abbreviations that might confuse or trip up your readers?

Use the Glossary to define a list of key terms, acronyms, and abbreviations and provide definitions for those terms in your content.

A sample Glossary page in a live knowledge base. The Glossary header displays at the top with hyperlinked numbers and letters of the alphabet below it. The first few glossary terms and their definitions are also displayed.Sample Glossary page

Here, you can define the terms, acronyms, and abbreviations used in your documentation. They're sorted and displayed alphabetically automatically. If you have terms beginning with numbers, these will be sorted and displayed first.

Readers can view your full glossary and access it from your table of contents.

You can show glossary terms and their definitions in your search results to help answer questions.

And you can provide definitions in-context as your readers explore content using our glossary highlighting feature. The glossary highlighting feature is a great way to improve consistency in your documentation while minimizing redundant work and keeping your docs looking clean. Automatically highlight glossary terms to set the number of times in articles definitions are automatically highlighted or manually insert definitions where you want them to appear.

Highlighted glossary terms get a double underline in articles and the definition will appear in a pop-up when readers hover over that term:

Screenshot showing a sample glossary term with double underline and on-hover definitionSample glossary term underlining and on-hover definition