Services

User manuals

The person who brings together the information on your machine also writes the manual.

Operating manuals, quick start guides, service manuals and UI texts for machinery and installations, in German and English, in the tool you work with.

How I work

  • One person from information to text. Whoever brings together the information on the machine also writes the manual. There is no handover between project management, writing and graphics.
  • In your tool. I work in your authoring system or in Word. The file belongs to you, and your team can continue editing it.
  • With CE coordinator competence. I know the requirements for user information under the Machinery Directive, the Machinery Regulation, ISO 12100 and IEC/IEEE 82079-1, and I align the manual with the CE marking process.
  • Honest about limits. A manual does not replace a guard or any other technical protective measure. It passes on correctly what your design engineers have decided. Responsibility for conformity stays with the manufacturer and the competent bodies.
  • German and English as native languages. The English source version is written alongside, not translated afterwards.
  • Predictable through patterns. Predictability comes from knowing how such projects run, not from the size of a team.

U1 – U12

Twelve services around the manual

Each service has a fixed frame. I bill at an hourly rate; before you commit, I review your documents and give you an estimate of the effort and a date.

Create

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 organized 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

Check and revise

U3

The manual check

Also for manuals written with AI

Manuals are written once and then only added to. Over time the operating steps no longer match the software, warnings sit in the wrong place, and the troubleshooting part stops exactly where things get difficult. Manuals written fully or partly with AI read fluently; whether they are correct only a check will show.

I check in three passes: completeness against the standard and machinery law; safety, meaning whether warnings sit where the hazard arises and match the residual risks; and clarity for someone without prior knowledge. You receive a written report with every finding in its place, ranked by weight, and an estimate of the effort a revision would take. What you do with it is your decision: change it yourself, commission your current provider, or me.

Hourly rate, scope agreed in advance

U4

The revision

Ready for the Machinery Regulation

Your manual isn’t wrong. It is simply older than the Machinery Regulation (EU) 2023/1230, which applies from January 20, 2027. I revise it in a targeted way where it is needed, not page by page. A check beforehand shows you exactly where that is.

Anyone supplying machinery to the EU from Switzerland or any other country needs a manual that meets EU machinery law.

Hourly rate, effort estimated after the check

U7

The safety chapter

One standard for all products

Every one of your manuals has a safety chapter, and it is probably a little different each time. I build it once as a standard for all your products, with fixed modules for warnings, residual risks and intended use. After that you only maintain the differences.

Fixed scope, hourly rate

Tools and upkeep

U2

Word, done right

Template, building blocks, style guide, training

For a few products and infrequent changes, Word is the right tool, provided it is set up properly. You receive a template with styles for every text type, building blocks for safety messages and warnings, an outline based on IEC/IEEE 82079-1, layout rules that survive translation, a rule for freezing and archiving versions, a short style guide and a training session.

If you wish, I move your first manual into the new template straight away. After that you won’t need me. That is intentional.

Fixed scope, hourly rate · More about Word

U11

Manual maintenance

Quarterly update service

Your machine keeps evolving; your manual often doesn’t. With a fixed allocation per quarter I work changes in continuously and freeze every delivered version. That way the manual matches every machine that has shipped.

Fixed allocation per quarter

U12

Writing for translation

Preparing and coordinating translation

Translation is charged per word. Every unnecessary and every ambiguous word is paid for again in every language. I prepare your source texts so that every language becomes cheaper and clearer: short, unambiguous sentences, fixed terminology, no text in the images. I align the terminology with your translation provider.

Fixed scope, hourly rate

Extra capacity

U5

Extra capacity

For peaks, vacations, parental leave and open positions

Some months everything arrives at once: two deliveries, a change in a standard, and right then a colleague is on parental leave or a position is still open. I join for a fixed period, on site or remotely, and work in your system, by your style guide and with your templates, whether that is a component content management system, XML or Word. I need to learn your product, not technical writing.

At the start we settle what has to be finished in that time and who approves it. I don’t question your rules unless you ask me to. Whatever I notice I write down; you get the list at the end. At the close I hand over a short status: what is done, what is open and where everything is.

Fixed period, agreed minimum scope, hourly rate; in Switzerland preferably as fixed-term employment · for DITA projects see DITA XML

U2 in detail

Word, done right

You don’t need a component content management system to have a good manual. Word is well suited to operating manuals, provided you know what you are doing.

When Word is the right choice

  • You have few manuals, or they rarely change.
  • Your team is meant to maintain the manual itself in the future.
  • You want no license costs, no system rollout and no dependence on a provider.
  • Release and review already run through Word, SharePoint or document control.

What “done right” means

  • styles instead of manual formatting, with consistent names
  • Quick Parts for recurring texts such as safety messages and warnings
  • invisible tables so that pictogram and message stay together
  • no text in images, and room for longer translations
  • fixed rules for page breaks and chapter openings
  • versions frozen and archived as PDF, because Word cannot do that itself

When I advise against it

With large but similar product families, very many images or many languages with frequent changes, Word reaches its limits. I tell you so before you invest. The next step then is the structure check.

Terms & contact

Getting started

You work with me directly, not with a team. The services are open to organizations in every country, freelance and project-based.

Hourly rate

Estimate after reviewing your documents

Write to me about the product and the date by which the manual has to be ready. We exchange documents once your non-disclosure agreement is signed. Then I give you the hourly rate, an estimate of the effort and a date.

Switzerland

Employment preferred

For organizations in Switzerland, I prefer to work in fixed-term or permanent employment. Project-based freelance work is possible as well.

Based in the Rhine Valley — close to St. Gallen, Vorarlberg and Lake Constance.