Word in der technischen Dokumentation
Ein Standardwerkzeug für eine so komplexe Aufgabe – geht das?
Das geht sogar recht gut, wenn wir einige Besonderheiten beachten, die technische Dokumentationen von anderen Dokumenten unterscheidet.
- Technische Dokumentationen sind häufig deutlich mehr als 50 oder 100 Seiten lang; bei Softwaredokumentationen sogar mehrere 100 Seiten.
- Dazu müssen unter Umständen Dokumentationen in einzelne Kapitel zerlegt werden.
- Im Gegensatz zum Beispiel zu einer wissenschaftlichen Arbeit, die auch umfangreich ist, aber in der Regel nur ein einziges Mal ausgedruckt wird, leben technische Dokumentationen viele Jahre oder Jahrzehnte.
- Das erfordert Disziplin im Umgang mit Formatierungen und Seitenaufbau, um den Effekt zu verhindern, den vielleicht jeder schon einmal gehabt hat: man macht eine kleine Änderung und plötzlich sieht das Dokument ganz anders aus.
- Dabei kann Word unterstützen, indem unterschiedliche Dokumente von verschiedenen Personen bearbeitet und in Form von Zentral-/Filialdokumenten zusammengeführt werden, oder aber über intelligente Feldfunktionen ein Dokument in ein anderes eingebunden wird.
- Immer wieder müssen Inhalte umgruppiert oder in ihrer Anordnung herauf- oder heruntergestuft werden.
- Hierbei den Überblick zu behalten ist eine Herausforderung, bei der Word den technischen Redakteur mit der Funktion Gliederungsansicht sehr komfortabel unterstützt.
- Neben dem bekannten Instrument des Kommentars gibt es die von uns empfohlene Variante, solche Einfügungen direkt in den Text zu schreiben und dort dann versteckt zu formatieren.
- Auch hierzu sollte man sich genau überlegen, wie solche Grafiken eingebaut werden.
- Wir empfehlen, Grafiken über Feldverweise einzubauen, denn dann kann eine Grafik in mehreren Dokumenten verwendet werden und bei Aktualisierungsbedarf muss sie nur einmal an der Quelle bearbeitet werden.
- Typische Fälle sind Inhalts-, Abbildungs- oder Schlagwortverzeichnisse, deren Einträge und Verweise auf Seitenzahlen nicht immer wieder neu von Hand geprüft und angepasst werden müssen, sondern direkt von Word mittels Feldfunktionen verwaltet werden.
Was kann Word nicht:
- Texte oder Textsegmente redundanzfrei ablegen. Solche Elemente, die charakteristisch für Redaktionssysteme sind, kann Word grundsätzlich über sogenannte Textbausteine abbilden, die in einer Dokumentvorlage abgelegt sind und in einem Dokument verknüpft werden können. Das ist jedoch aufwändig und fehleranfällig.
Hier unterstützen Redaktionssysteme die technische Redaktion, wie zum Beispiel OfficeForms von dokay.
- Häufig müssen technische Dokumentationen nicht nur als PDF, sondern auch als Online-Hilfe ausgeliefert werden. Worddokumente sind zwar im Kern XML-Dateien, der Output erfordert jedoch viel technische Nacharbeit, um wirklich browserfähige Präsentationen entstehen zu lassen.
Diese Lücke füllen Content-Managementsysteme wie zum Beispiel OfficeHelp von dokay.
