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 ...
Get IBM Style Guide, The: Conventions for Writers and Editors 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.
