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
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.
Was sich dadurch ändert
- Eine Änderung wird einmal gemacht und erscheint überall
- Übersetzungen betreffen nur die Bausteine, die sich geändert haben
- Neue Produktvarianten entstehen durch Neuzusammenstellen
- Rollen bekommen ihre Auswahl statt denselben Textklotz
- Jeder Baustein hat eine zuständige Person
- Veraltetes fällt auf, weil es einzeln datiert ist
Wie viel Ihrer Dokumentation existiert doppelt?
Meist zeigt schon eine Stichprobe, wie viel Arbeit in der Pflege von Kopien steckt.