O'Reilly logo

Read Me First! A Style Guide for the Computer Industry, Third Edition by Sun Technical Publications

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 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

• “Abstracts” on page 206

• “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

• “Release Notes and Product ...

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