IBM Style Guide, The: Conventions for Writers and Editors

Chapter 9. Glossaries

Create clear, concise glossary entries to make it easier for users to understand concepts. A glossary defines terms that are used in a product, set of products, or technology area.

Structure of glossary entries

A glossary entry consists of the following components:

• A glossary term

• One or more of each or both of the following items:

• A definition of the term, optionally followed by one or two explanatory sentences and a See also reference that points to a related term or terms

• A See reference that points to a preferred synonym for that term or to the spelled-out version of an abbreviated term

If there is more than one item, each item is numbered.

Examples

migrate

To move data from one location to another.

backout ...