In this chapter, I will introduce the subject of Crafting Public Style Guides. A style guide is a set of guidelines and standards that define the writing style, formatting, and other aspects of documentation. Its purpose is to ensure written materials’ consistency, clarity, and professionalism (see Figure 8-1).
A tree diagram with benefits of creating a Docs style guide. Includes consistency ...
Get Docs-as-Ecosystem: The Community Approach to Engineering Documentation 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.
Dive in for free with a 10-day trial of the O’Reilly learning platform—then explore all the other resources our members count on to build skills and solve problems every day.
