Was Topic-based Writing praktisch bedeutet.
Nicht jeder liest das Handbuch. Alle suchen die eine Stelle.
Vom Buch zum Baustein
Ein Handbuch wird vorne begonnen und hinten beendet – benutzt wird es in der Mitte, an einer einzigen Stelle.
Ein Baustein beantwortet genau eine Frage und ist für sich verständlich, egal woher jemand kommt.
Aus Bausteinen lassen sich Handbuch, Hilfeseite und Displaytext bauen – aus einem Handbuch nur ein Handbuch.
Die drei Sorten Baustein
Die Einteilung ist nicht ausgedacht: In DITA heißen die drei Typen Task, Concept und Reference. Im deutschsprachigen Raum wird auch nach Funktionsdesign, Information Mapping oder PI-Mod strukturiert, für den Austausch zwischen Systemen gibt es iiRDS.
Anleitung
Eine Aufgabe, nummerierte Schritte, ein überprüfbares Ergebnis. Keine Theorie dazwischen.
Erklärung
Warum etwas so ist, wie es ist. Steht daneben, nicht mittendrin – wer sie nicht braucht, überspringt sie.
Nachschlagen
Werte, Grenzen, Parameter. Wird gesucht, nicht gelesen, und muss deshalb auffindbar sein.
Ein Baustein als Beispiel
Anleitung: Filter wechseln
Ziel: Der Luftfilter ist getauscht, die Anlage läuft wieder.
1. Anlage ausschalten und gegen Wiedereinschalten sichern.
2. Filterdeckel mit den beiden Rändelschrauben lösen.
3. Alten Filter herausziehen, neuen Filter mit dem Pfeil nach oben einsetzen.
4. Deckel schließen, Anlage einschalten.
Ergebnis: Die Anzeige „Filter“ erlischt.
Dieser eine Baustein erscheint an drei Stellen, ohne kopiert zu werden:
Im PDF-Handbuch vollständig, im Kapitel Wartung.
In der Online-Hilfe als eigene Seite, direkt aufrufbar über die Suche nach „Filter“.
Auf dem Display als Kurzfassung, sobald die Meldung „Filter wechseln“ erscheint – mit Verweis auf die vollständigen Schritte.
Ändert sich die Schraube, wird der Baustein einmal korrigiert.
Was sich dadurch ändert
- Eine Änderung wird einmal gemacht und erscheint überall – das Prinzip Single Source of Truth
- Übersetzungen betreffen nur die Bausteine, die sich geändert haben
- Neue Produktvarianten entstehen durch Neuzusammenstellen
- Rollen bekommen ihre Auswahl statt dasselbe 200-Seiten-Handbuch
- Jeder Baustein hat eine zuständige Person und nutzt die Begriffe der Terminologieliste
- Veraltetes fällt auf, weil es einzeln datiert ist – mehr dazu unter Inhalte brauchen ein Ablaufdatum
Passt dazu
Bevor umgebaut wird, lohnt sich der Blick auf den Bestand: Was ein Dokumentations-Audit zutage fördert. Und die Frage, wo Warnhinweise in Bausteinen stehen, ist damit sofort mitentschieden.
Wie viel Ihrer Dokumentation existiert doppelt?
Meist zeigt schon eine Stichprobe, wie viel Arbeit in der Pflege von Kopien steckt.