A well-structured and easily comprehensible operating manual is an essential factor for the successful use of machines, systems and other equipment.

Clarity before attention to detail

The information content of operating instructions is decisive for their comprehension. Important information should be emphasised using visual highlights such as bold print, italics or information boxes. Technical details are important, but they must be presented in such a way that even inexperienced users can understand them. Clear and simple language is essential to prevent misunderstandings. Linguistic clarity naturally also includes the consistent use of technical terms. Inconsistent terms for product components can otherwise lead to a great deal of confusion.

Standards and directives
When dealing with claims in the event of damages, operating instructions are one of the main criteria when it comes to assessing liability. This is why it is of vital importance that applicable legislation and legal requirements are taken into account. No compromises should be made, especially with regard to safety instructions. These must be structured and formatted on the basis of the risk assessment laid out in ANSI/ISO guidelines. Furthermore, the applicable standards and directives must be observed (Machinery Directive, EN 82079 etc.). In this respect we make sure that our entire team is regularly trained and kept up to date with the latest developments.

Graphics
Easy-to-understand graphics are essential for explaining complex procedures in a simple manner. A wide variety of image types can be created using 3D data; technical illustrations, renderings or sectional views. Depending on the completeness and validity of the 3D data, the use of photos can also be important.

Size of texts and images 
In digital manuals it is possible to zoom in on texts and images. This is obviously not the case with printed instructions – which means that it is essential to make sure that the text and illustrations are large enough. For this reason it is also important for our technical authors at DOGREL to occasionally print out manuals in their original size and not just view their contents on a screen. This is the only way to make sure that the manuals are easy to read.

Conformity with the product
Nothing is more confusing than incorrect information in operating instructions. However, as operating manuals are often compiled during product development, sometimes information does not correspond with the current product status. For this reason it is particularly important to check the quality thoroughly before publication.