This chapter explains how to create a glossary for a technical manual. Most technical manuals increasingly introduce a number of new terms. A glossary improves the usability of a technical manual by simplifying a reader’s search for definitions for these new terms. Before you create a glossary, consider its use and organization.
This chapter discusses the following topics:
“Glossary Content” on page 231
“Terms for an International Audience” on page 233
“When to Include a Glossary” on page 234
“Writing Good Glossary Entries” on page 234
The terms that you select for a glossary must be important to the subject, with simple and concise definitions that are appropriate for the context. A glossary can contain ...