Show/Hide Toolbars

Technical Writers’ Companion

Navigation: Structuring

Which document sections?

Scroll Prev Up Next More

When creating user assistance for software, you’re mostly free to choose which sections to include, and how to label them.

When you’re documenting hardware, however, standards and legal requirements often call for you to include specific components and to create a particular structure.

Caution: Always check whether there are any specific standards or legal requirements for your products and for the countries in which you sell your products. If there are any binding requirements, adhere to them strictly.

Within the scope that you have:

Only include those sections that add substantial value for users.

Find headings that reflect the users’ goals. Avoid abstract terms. For example, call a section “Assembling Your …” rather than “Assembly Instructions.”

Expand /Collapse All Subsections

© indoition publishing e.K., all rights reserved – Imprint and Terms of Use | Privacy Policy