Technische Dokumentation
strukturieren
Welche Dokumente sollten Sie vorsehen? Gedruckte Handbücher (PDF), Online-Hilfe (HTML) oder beides?
Welche Abschnitte sollte jedes der Dokumente enthalten? In welcher Reihenfolge?
Welche Navigationshilfen können Sie anbieten, um sicherzustellen, dass die Leser die benötigten Informationen auch finden? (Machen wir uns nichts vor: Niemand liest eine Bedienungsanleitung von vorne bis hinten.)
Technische Dokumentation
gestalten
Wie sollte das Layout Ihrer Dokumente aussehen? Welche Seitengröße, Fenstergröße, Farben, Schriftarten, Zeilenlängen, Zeilenabstände, Absatzformate, Zeichenformate, Tabellenformate … sollten Sie vorsehen?
Was macht ein Design benutzerfreundlich, so dass Leser die Informationen einfach finden, optimal nachvollziehen und dauerhaft behalten können?
Was macht eine Formatvorlage (Template / Stylesheet) autorenfreundlich, so dass …
… Sie die Formate effizient zuweisen können?
… sich der Layoutprozess möglichst weitgehend automatisieren lässt?
… Sie die Formate später jederzeit leicht wieder ändern können, sollte dies erforderlich werden?
Technische Dokumentation
schreiben
Wie sollten Sie schreiben, so dass jeder Leser versteht, was Sie meinen?
Wie vereinfachen Sie Kapitel, Abschnitte, Sätze und sogar einzelne Wörter?
Welche Benennungen sollten Sie in Technischer Dokumentation verwenden, und welche Wörter sollten Sie vermeiden?
Häufige Fragen zu Rechtschreibung und Zeichensetzung.
Technische Dokumentation
visualisieren
Wann und wo eignen sich Bilder, Videos oder interaktive Inhalte besser als Text zu Erklärung und Anleitung?
Wie sollten Sie Bilder und Videos allgemein gestalten?
Tipps zum Erstellen speziell von Bildern, die physische Geräte zeigen.
Tipps zum Erstellen speziell von Bildern, die Software zeigen (Screenshots).
Tipps zum Gestalten und Einbinden effektiver Anleitungsvideos.