Anleitungen, die im Ernstfall funktionieren.
Wenn etwas schiefgeht, zählt nicht, ob die Dokumentation vollständig war – sondern ob jemand sie verstanden hat.
Kommt Ihnen das bekannt vor?
Ihr Support beantwortet dieselbe Frage zum fünften Mal in dieser Woche – und die Antwort steht eigentlich im Handbuch.
Die Anleitung ist ein PDF mit 200 Seiten. An der Maschine macht das niemand auf, also wird nach Gefühl gearbeitet.
Vor dem nächsten Audit will keiner so recht in die Unterlagen schauen, weil niemand genau weiß, was drinsteht.
Was es kostet, wenn es so bleibt
Macht jemand im Betrieb einen kritischen Fehler, weil die Dokumentation missverständlich war, haftet im Ernstfall der Hersteller. Das ist der teuerste Fall – aber nicht der häufigste.
Der häufigste ist leiser. Er steht in keiner Bilanz, weil er sich auf viele kleine Posten verteilt.
Die leisen Kosten
Arbeitszeit. Jede Routinefrage, die im Support landet, wäre in der Anleitung beantwortet – wenn man sie fände.
Übersetzung. Lange Sätze und uneinheitliche Begriffe werden bei jedem Produktupdate neu bezahlt, in jeder Sprache.
Einarbeitung. Ohne roten Faden brauchen neue Kollegen Monate statt Wochen – und mit dem Abgang geht das Wissen wieder.
Wie ich vorgehe
Ich lese, was Sie haben
Und sage Ihnen, wo es bricht: welche Dokumente ein Haftungsrisiko tragen, wo Informationen doppelt liegen, wo die Struktur Ihre Leute im Stich lässt.
Ich ordne die Inhalte neu
Modular, nach Rollen getrennt, nach IEC/IEEE 82079-1 und den tekom-Leitfäden, bei Maschinen zusätzlich nach DIN EN ISO 20607. Jede Information existiert genau einmal. Warnhinweise stehen dort, wo gehandelt wird.
Ich hinterlasse Regeln
Vorlagen, Schreibregeln und feste Zuständigkeiten – damit Ihr Team ohne mich weitermacht und die Unterlagen in zwei Jahren noch stimmen.
Was am Ende auf dem Tisch liegt
- Ein Befundbericht: welches Dokument welches Risiko trägt, nach Dringlichkeit sortiert
- Eine Struktur, in der jede Information einmal existiert und überall erscheint, wo sie gebraucht wird
- Vorlagen und Schreibregeln, mit denen auch Nicht-Redakteure brauchbare Texte schreiben
- Warnhinweise nach SAFE-Methode (ANSI Z535.6) – im Sicherheitskapitel und zusätzlich im Handlungsschritt
- Eine Terminologieliste, die bei jeder Übersetzung bares Geld spart
- Eine Übergabe mit Schulung, nach der Ihr Team selbst weiterarbeitet
Woher ich das kann
Seit 2022 baue ich für die i22 Digitalagentur die Informationsarchitektur einer Entertainment-Plattform der Deutschen Telekom: semantische Modellierung und Pflege komplexer Produktdaten in CoreMedia.
Davor fünfzehn Jahre digitale Content-Systeme beim Südwestrundfunk, unter anderem für SWR.de und die SWR-Aktuell-App. Wie ich solche Systeme ordne, steht unter Content-Management; wie Inhalte für ihre Leser geplant werden, unter Content-Strategie.
Die Technische Redaktion habe ich auf dieses Fundament aus Struktur- und Systemarbeit gesetzt: Qualifizierung zum Technischen Redakteur (tekom Professional Level), Zertifikatsprüfung September 2026. Dazu ein Soziologiestudium, das mir beigebracht hat, Systeme zu zerlegen, bevor ich sie neu baue.
- Deutsche Telekom
- SWR
- roadsurfer
Eine Arbeitsprobe, die Sie gerade benutzen
Kontextsensitive Hilfe heißt: Die Erklärung steht dort, wo die Frage entsteht – nicht in einem Handbuch, das niemand aufschlägt. Diese Website macht das vor. Überall, wo ein Fachwort auftaucht, lässt es sich antippen. Probieren Sie es hier: Gute Dokumentation ist modularInhalte werden in einzelne, wiederverwendbare Bausteine statt in durchgehende Kapitel aufgeteilt. Erleichtert Pflege und Übersetzung, weil sich jeder Baustein einzeln aktualisieren lässt. aufgebaut und folgt dem Prinzip Single Source of TruthDie eine zentrale Quelle, aus der eine Information stammt – alle anderen Stellen verweisen darauf, statt sie zu wiederholen. Verhindert widersprüchliche Angaben in mehreren Dokumenten..
Dahinter steckt genau das Prinzip, das ich auch in Produktdokumentation anwende: Alle Erklärungen stehen an einer einzigen Stelle und werden von dort in jeden Text eingesetzt. Ändert sich eine Formulierung, ändert sie sich überall – Single Source of Truth, in klein.
Wie es gebaut ist
Ein Begriffsverzeichnis im Seitengenerator, ein Auszeichnungswort im Text, dreißig Zeilen JavaScript. Ohne JavaScript erscheint die Erklärung als Einschub im Satz – der Text bleibt in jedem Fall vollständig.
Keine Erweiterung, kein fremder Dienst, keine Einwilligung nötig.
Dasselbe lässt sich in Ihre Produktdokumentation einbauen – als Hilfe direkt an der Oberfläche, statt als PDF daneben. Wie ich Dokumentation dafür aufbereite, steht unter Topic-based Writing in der Praxis.
Zum Weiterlesen
Warnhinweise, die im richtigen Moment stehen
Warum das Sicherheitskapitel allein nicht reicht – und wie ein Hinweis nach SAFE aufgebaut wird.
Lesen BestandWas ein Dokumentations-Audit zutage fördert
Dubletten, Waisen, Lücken: die drei häufigsten Funde und was Sie bereitlegen sollten.
Lesen StrukturWas Topic-based Writing praktisch bedeutet
Vom Handbuch zum Baustein – und was sich dadurch bei Pflege und Übersetzung ändert.
LesenHäufige Fragen
Wie läuft die Zusammenarbeit ab – Projekt oder laufende Unterstützung?
Beides kommt vor. Am Anfang steht fast immer ein abgegrenztes Projekt: ein Audit des Bestands, danach die neue Struktur für einen Produktbereich. Wenn das steht, arbeiten manche Kunden allein weiter, andere buchen mich regelmäßig für neue Produkte oder Releases.
Was kostet das?
Das hängt vom Umfang ab – ein Audit über dreißig Dokumente ist etwas anderes als der Umbau einer ganzen Dokumentationslandschaft. Wenn ich weiß, worüber wir reden, nenne ich Ihnen einen Festpreis oder einen Tagessatz, je nachdem, was besser passt.
Arbeiten Sie mit unserem Redaktionssystem?
In der Regel ja. Ich habe mit CoreMedia, WordPress, XML-basierten Formaten und Confluence gearbeitet, dazu mit Markdown im Docs-as-Code-Verfahren. Arbeiten Sie mit einem Redaktionssystem für Technische Dokumentation wie Schema ST4 oder Paligo, plane ich die Einarbeitung darin ins Projekt ein. Wichtiger als das System ist ohnehin die Struktur dahinter: Eine saubere Modularisierung lässt sich in fast jedes Werkzeug überführen, eine unsaubere bleibt auch im teuersten System unsauber.
Nach welchen Normen arbeiten Sie?
Maßgeblich für Anleitungen ist IEC/IEEE 82079-1, für Maschinen DIN EN ISO 20607, für Warnhinweise ANSI Z535.6. Ab 20. Januar 2027 gilt die Maschinenverordnung (EU) 2023/1230 mit neuen Regeln, unter anderem für digitale Anleitungen. Dazu kommen die Leitfäden der tekom, des Berufsverbands für Technische Kommunikation im deutschsprachigen Raum, etwa zum regelbasierten Schreiben und zu Sicherheits- und Warnhinweisen.
Meine Qualifizierung zum Technischen Redakteur (tekom Professional Level) schließe ich mit der Zertifikatsprüfung im September 2026 ab. Praktisch heißt das: feste Satzmuster, kontrollierter Wortschatz, modulare Struktur und Warnhinweise an der richtigen Stelle.
Übernehmen Sie die Haftung für die Dokumentation?
Die Produkthaftung bleibt beim Hersteller, daran kann kein Dienstleister etwas ändern. Was ich tue, ist das Risiko zu senken: Warnhinweise normgerecht konstruieren, Lücken aufdecken und die Struktur so bauen, dass sie einem Audit standhält. Für die rechtliche Prüfung im Einzelfall arbeiten wir mit Ihrer Rechtsabteilung oder Ihrem Anwalt zusammen.
Arbeiten Sie vor Ort oder aus der Ferne?
Der größte Teil läuft aus der Ferne, das spart allen Zeit. Für den Auftakt, für Werksbesichtigungen und für Workshops komme ich gern vorbei – im Großraum München ohne Aufwand, darüber hinaus nach Absprache.
Reden wir eine Viertelstunde darüber.
Erzählen Sie mir kurz, wie Ihre Dokumentation heute entsteht und wo es klemmt. Danach wissen wir beide, ob und wie ich weiterhelfen kann – unverbindlich.