U1
The manual
Written from scratch, in Word or in your system
The manual is the last document anyone needs and the first one missing at the end. I write it so that it fits your machine. That starts with the information your people already have, as documents, photos or videos, and with the knowledge of those who built it and commission it.
I take your documents as they are: drawings, risk assessment, parts lists, old manuals, notes. Whatever is missing I ask for specifically, in a few well-prepared meetings. First comes an outline that you approve before much work has gone into it. Then the safety instructions, operation, cleaning, maintenance and troubleshooting follow, written for the people who actually read the manual: the operators on shift.
Estimate and date after reviewing your documents
U6
Two languages from one pen
German and English at the same time
German and English are my native languages. Your manual is written in both at the same time, from the same understanding of the machine. The English version is a second source version for English-speaking readers, not a translation. I align technical terms and warnings in both languages once and from the start, so that a term like ‘emergency stop’ triggers the same response in both versions.
For the United States, I take local conventions for safety messages into account, such as ANSI-style formatting. Further languages are translated by your translation provider from the version of your choice.
As an addition to U1 or U4, within the same assignment
U8
The quick start guide
Quick start at the machine
The full manual sits in the office, the machine stands on the shop floor. A quick start guide at the machine shows the steps needed every day, with pictures and as little text as possible. It does not replace the full manual and refers to it visibly.
Hourly rate, effort estimated in advance
U9
Service manuals
Maintenance, installation, troubleshooting
Troubleshooting organised by the table of contents helps nobody in service. I write maintenance, installation and troubleshooting manuals along the path technicians actually take: from the symptom via the cause to the fix.
Hourly rate, as a project or for a fixed period
U10
UI texts and help
HMI texts, messages, online help
The best manual is the one you never have to open. I write messages, menu texts and help texts for your user interface. They say what has happened and what to do now, and they use the same terms as the manual.
Fixed period, agreed scope