The brief, intensive itl seminar on technical documentation – bringing together 35 years of practical expertise.
We offer the benefit of years of practical experience – combined with the right theory.
Technical writers, technical translators and anyone working in technical documentation and involved in planning documentation projects.
Basic experience of technical documentation is helpful but not a necessity. Please bring your own laptop so that you can do the exercises during the seminar.
Theory- and practice-based models
Why do we talk about best practice but not best theory?
Learning by doing without a theoretical basis remains just a patchwork.
Readability – the concept
From Hamburg via Vienna and Karlsruhe to Munich – we present the Munich readability model, the comprehensive model for technical documentation.
It will all become clear to you, in much the same way as Mark Twain described: "The difference between the almost right word and the right word is really a large matter – it's the difference between the lightning bug and the lightning."
Readability – word selection and terminology
Why is it always best to call a spade a spade? Why is terminology essential rather than just nice to have.
And why is a general dictionary no longer enough?
Readability – sentence structure
Why simple sentence structure is ideal for good technical documentation.
Why what they taught you about writing at school can lead you astray.
Readability – information elements, sequencing
The best of Information Mapping®, Funktionsdesign®, DITA® and the principles of parallelism.
Why it is essential to correct the myths about ANSI, ISO and SAFE.
Exclusive: all signal words in 40 languages, all the key parts of widely used standards and directives.
Readability – mental models
Why we don't understand each other and when we understand each other. Knowledge of mental models the key to readability.
Readability – visualisation
Mental models are the starting point for efficient visualisation.
The analogy of typesetting rules for clear visual grammar.
The new possibilities of moving images (videos, 3D, animated GIFs).
Process orientation – topic design
From document orientation to topic design.
Every page is page one. Users don't want to read for the sake of it; they want answers to questions: the solution is topic design rather than chapters and sections.
Process orientation – structuring, modularisation, classification
The difference between modules and topics. From conventional Information Structure Design to PI® classification. The best of Information Mapping®, Funktionsdesign® and DITA®.
User-friendly design – fundamentals
How do you use technical documentation? And what design criteria facilitate the various usage types to optimum effect? Comprehensive concept for the systematic, efficient design of technical documentation.
m-ISD (multimedia Information Structure Design)
Electronic documentation on mobile devices requires fundamentally new conclusions to be drawn, including about the concepts that still apply when structuring and using technical documentation. This brief, intensive seminar provides a new framework model for the planning of mobile multimedia documentation.
Legislation – directives – standards
The seminar navigates a path through the jungle of directives, legislation and standards involved in technical documentation. At the same time, widely held assumptions, such as that technical documentation has to be created using particular software or printed on paper, are exposed as myths.