Rich Documentation Design Concept

Technical documentation is all the more valuable the faster it delivers exactly the information its users need at any given moment. Like an energy bar for an athlete, rich documentation provides many readily available calories with little volume. The Rich Documentation Design Concept supports creating documentation that has a high “nutrient density”: rich in immediately usable content, poor in useless dead weight.

Best Practices Technische Dokumentation: Handbücher und Hilfen anschaulich illustrieren und animieren – Bilder, Videos, Interaktion

Free Preview

Vorschau öffnen

Note:  The preview includes the entire document. If you find the content useful, please purchase a copy. Thank you.

Achtelig, Marc
Rich Documentation Design Concept
Methods for Creating Concise Technical Documentation of Maximum Value

English Edition
58 pages in A4 format
Available to download as an ebook in PDF format right here

 

 

Most people can handle technology much better today than in the past. In addition, many products are becoming increasingly easy to use. However, many classic documentation concepts are still based on the dogmas of “consistency” and “completeness”.

Due to the wealth of functions and settings that many products offer today, such documentation is hardly any longer manageable – neither for its authors nor for its users. Despite the high effort put into writing such documentation, users often learn a lot of useless and trivial things. In extreme cases, for example, they learn that they can save their data using the “Save” function, or that the “Print” function is used to print a document. The few important and relevant pieces of information about backgrounds and correlations are buried in the documentation and are not found.

Creation, maintenance, translation, and printing of the documentation are more expensive than necessary. Yet the result is not optimal. Users must laboriously separate valuable content from irrelevant clutter. This costs time and energy. User experience? Poor.

This does not mean that established documentation concepts and methods are inappropriate. But it is time to reinterpret and to rethink them at one point or another. It is also time to take more account of the fact that a lot of documentation today is online documentation, which presents a whole new set of possibilities compared to documentation printed on paper or compared to a PDF file.

For more than 25 years of consulting and editorial work, I have encountered this issue in almost every project. With growing urgency. To standardize solutions and to allow others to also benefit from them, the Rich Documentation Design Concept with its Impulse Method and its Minimal Brainwork Principles emerged.