Standard sections in hardware user assistance

Print topic Print topic Previous topic  Next topic

For hardware user assistance, use the following catalog of standard sections as a checklist.

Depending on your particular product, some sections may not be necessary, and you may be able to omit them.

Typically, the sections roughly appear in the order given below. However, if you have a good reason to change the order, feel free to do so.

If you provide more than one document, the sections can go into different documents.

Unless particular standards require you to use the formal titles given in the catalog, when possible use less formal, more task-oriented or goal-oriented headings. For example, instead of “Device description” a more attention-grabbing and motivating title could be “Components and controls that you need to know.”

Typically, each new section starts on a new page, but sometimes it also makes sense to combine two or more sections, or to have several sections included on the same page.

Expand /Collapse All Subsections

Front cover (title page)

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Legal information (imprint)

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Declaration of EU Conformity

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Safety instructions

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of contents

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

See also Designing: Table of contents page layout

Preface

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

What’s new

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Specification and proper use

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Package contents

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Device description

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Accessories

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Assembly instructions

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Installation

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Initial start-up

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Getting started

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Concepts

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Procedures

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Application tips

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Reference information

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Technical documents

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Troubleshooting

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Maintenance

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Warranty

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Spare parts

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Service and customer assistance

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Disposal and environmental protection

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Glossary

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of figures

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of tables

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Index

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

See also Designing: Index page layout

Room for notes

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Cheat sheets

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Back cover

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm