Chapter 17. Glossary Guidelines
This chapter explains how to create a glossary for a technical manual. Most technical manuals 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 295
• “Terms for an International Audience” on page 297
• “When to Include a Glossary” on page 297
• “Writing Good Glossary Entries” on page 298
Glossary Content
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. ...
Get Read Me First! A Style Guide for the Computer Industry, Third Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
