Chapter 2. Constructing Text

This chapter provides information about the use of text and graphical elements, such as section headings, tables, and cross-references. Many acceptable ways exist to present these elements. The design, layout, and writing style that you choose will help make your document unique.

The style and writing conventions in this chapter include suggestions that have worked successfully in published computer documents. You might decide to adopt these conventions or to adapt them to your company’s documentation. Whatever convention you choose, make sure that the format is easily recognized and understood by readers. Use the style guidelines consistently throughout your document.

This chapter discusses the following topics:

  • “Headings” ...

Get Read Me First!: A Style Guide for the Computer Industry, Second Edition 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.