Skip to Content
IBM Style Guide, The: Conventions for Writers and Editors
book

IBM Style Guide, The: Conventions for Writers and Editors

by Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski
October 2011
Intermediate to advanced
416 pages
8h 15m
English
IBM Press
Content preview from 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 ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Style Guide for Business Writing

Style Guide for Business Writing

Michael C. Thomsett

Publisher Resources

ISBN: 9780132118989Purchase book