Fragen am Beginn
Verschiedene Faktoren müssen bei der Konzeption und Erstellung von Technischer Dokumentation berücksichtigt werden, deswegen gilt es zunächst einige Fragen abzuklären:
- der Produktzusammenhang
- die Produktentwicklung
- Interne Organisation und bestehende Dokumentation
- verfügbare Information oder Quellen
- kontextabhängige gesetzliche Vorgaben für die Technische Dokumentation
- Erwartungen, Ansprüche und Kenntnisstand der Doku-Adressaten
- Erwartungen und Ansprüche der künftigen Doku-Bearbeiter/innen
- die gewünschte Ausgabeform
- die verwendete Textverarbeitungssoftware
- Layout und Terminologie
- mögliche Lokalisierung, bzw. Übersetzung der Doku
Die Recherche
Generell ist es als Vorteil zu betrachten, wenn ich als Autorin zu Beginn der Arbeit den gleichen Kenntnisstand über das Produkt habe, wie die Doku-Adressaten. Ein Produktentwickler wird eher bestimmte Sachverhalte als bekannt oder verständlich voraussetzen, als ein Autor, der sich neu in die Materie einarbeitet.
Nach einer kurzen Einweisung führe ich die weitere Recherche gerne selbstständig auf der Basis von vorliegender Dokumentation, auskunftsfreudigen Ansprechpartner/innen, einem Testprodukt oder sonstigen Quellen durch.
Die Analyse von bestehenden Arbeitsabläufen ist da schon schwieriger und hängt stark von der Motivation und Beteiligung der Mitwirkenden ab. Es gibt immer Gründe für die Art und Weise, in der Dokumentation erstellt wird und nach meiner Erfahrung ist es häufig erfolgreicher und für die Beteiligten befriedigender, die Prozesse behutsam anzupassen und Bestehendes aufzugreifen als alles komplett über den Haufen zu werfen.
Textgliederung und Strukturierung
Das Geheimnis guter Technischer Dokumentation liegt in der Textgliederung, bzw. der Strukturierung des zu verwendenden Inhalts. Die Textgliederung innerhalb eines Dokumentes muss auf der einen Seite dem Dokuadressaten eine gute Orientierung und eine umfassende Darstellung der gesuchten Inhalte bieten. Auf der anderen Seite muss die Struktur des Textes den Anforderungen der künftigen Doku-Bearbeiter/innen entsprechen.
Komplizierte Produktstrukturen, häufige Produkt-Updates oder spezielle Vertriebsformen benötigen eine Dokumentation, die variabel reagieren kann.
Die Sammlung von Textmodulen mit statischem und dynamischem Inhalt, die zur Fertigstellung eines Dokumentes nur noch passend zusammengesetzt werden, ist hier die Lösung.
Produkte mit stark individueller Ausprägung benötigen dagegen eine produktionsbegleitende Form der Dokumentation. Hier ist die Konzeption von Vorlagen sinnvoll, in die die benötigten Informationen schon während des Fertigungsprozesses von verschiedenen Stellen zusammengetragen werden.
Umsetzung mit vorhandener Textverarbeitungssoftware
Für die Umsetzung reichen die Funktionen der Textverarbeitungssysteme Microsoft®Office – oder OpenOffice.orgTM in der Regel vollkommen aus. Beide Anwendungen enthalten eine Reihe von Funktionen zur Steuerung von dynamischen Textteilen (Zentral- /Filialdokumente, bedingte Texte, Variable etc.), die bei Bedarf durch einfache Makros ergänzt werden können.
So lassen sich kostensparend ohne aufwendige Einarbeitung komfortable Lösungen etablieren, die mit hoher Wahrscheinlichkeit auf Akzeptanz bei den mit der Dokumentation beschäftigten Mitarbeiter/innen stossen werden.