Technical documentation
To use a product to its full potential, users need good documentation. The high technical standard of your products should come along with accurate and user-friendly accompanying documents. Technical documents act as a bridge from the manufacturer to the user. However, only documents that are written with the user in mind can achieve this.
Proper structure and readability
Technical illustrations (technical diagrams)
Usability testing
Proper structure and readability
User manuals and operating instructions are more than just compilations of technical drawings and individual operating procedures. To ensure that the information provided is taken on board, manuals must be properly structured and easily understandable. In many cases, it is necessary to break down complex issues into clear, comprehensible and unambiguous instructions. A clear layout of your documents enables users to quickly find what they are looking for.
We know how to
- compile large volumes of information into well-structured documents
- explain complex issues in easy-to-understand language
- present the benefits of your products so that they become immediately apparent to users
- prevent accidents that might lead to claims against you by incorporating all necessary safety warnings
Technical illustrations (technical diagrams)
Illustrations (technical diagrams) help to simplify complex issues and to avoid misunderstandings. This ensures that your instructions are easier to follow. The reader can focus on what is really important. Redundant information is left aside. Properly drafted diagrams can save many words and are of direct benefit to users.
Example:
 |
A picture often says more than a thousand words. And as figures do not need to be translated, they can save you money ... |
Usability testing
The introduction of the EU Directive on Consumer Goods on January 1, 2002 also affects technical documents accompanying such consumer goods, i.e. assembly instructions. According to this Directive, a product is deemed non-conforming if its assembly instructions are insufficent or incorrect so that the product cannot be properly assembled. Whether the product itself is in proper working order or not is irrelevant here. Manufacturers therefore need control procedures in order to
- detect non-conforming parts of documents
- eliminate the risk of liabilty
- increase the competitiveness of their products
In usability tests, we establish whether the instructions are adequate for the product. Non-conformities in the instructions are thereby identified and eliminated. Testers use the manuals and attempt to assemble or operate your product. If this is not or only partly possible, the manual must be revised.