Chapter 10. Types of Technical Documents
Many different types of documents exist. The documents range from a single-chapter manual, such as a white paper or simple installation guide, to a highly technical user’s guide or training manual. Technical documents are often part of a documentation set that contains several documents. Many companies produce documents do not follow a book model.
This chapter discusses the following topics:
• “What Is a Documentation Set?” on page 203
• “Documentation Plans” on page 204
• “Structure of Manuals” on page 206
• “Descriptions of the Manual Parts” on page 208
• “Types of Hardware Manuals” on page 211
• “Types of Software Manuals” on page 212
Get Read Me First! A Style Guide for the Computer Industry, Third 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.
