O'Reilly logo

The IBM Style Guide: Conventions for Writers and Editors by Eric Radzinski, Leslie McDonald, Amy Laird, Jana Jenkins, Peter Hayward, Francis DeRespinis

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 4. Structure

Follow these guidelines to present information in a clear and logical structure.

Topic-based information

Topic-based writing is an approach to writing well-structured, minimalist information that is usually presented online.

A topic is an independent unit of information with the following characteristics:

• It is meaningful when it is displayed alone.

• It follows the rules for a specific topic type.

A book establishes a progression of information that readers are expected to follow in a sequence. By contrast, online information encourages readers to approach topics from various directions. Writers of online information divide information into topics that can be read independently.

There are three main topic types:

Task ...

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