O'Reilly logo

Read Me First!: A Style Guide for the Computer Industry, Second Edition by Sun Technical Publications

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Chapter 13. Glossary Guidelines

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

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. A glossary can contain ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required