Home> About us > Branding guidelines > Documents > Manufacturing documents >

Chapter specification - Operational procedures

This chapter is used in the following manuals:

This is probably the most important chapter in the manual.

This chapter shall provide the specific instructions to how the product is used. In order to define which procedures that are required, you must first define the main purpose of the product, then its mains functions, and finally decide which procedures that needs to be written. In most cases you will not be able to write all relevant procedures. Discuss which procedures to include with the product manager and your customer support organization.

The procedures must be aimed at both casual and expert users.

Procedures related to software installation and maintenance may be included unless they are provided in separate chapters.

Chapter structure and section titles

Since very many procedures are often required, a good solution may be to use sections to collect procedures related to the same features or functions.

Due to the different nature of our products, it is not possible to define a generic structure with fixed section names.

Procedure titles

See Writing rules: Writing procedures

Topic structure

Structured topics are essential to create modular documentation. By breaking down the information to easily recognizable elements that comply to a defined structure, the elements are easier to locate and reuse in other sections, chapters or books. Makes sure that file names reflect the element’s position in the structure.

See Writing rules: Writing procedures

Topics

Back to