2013/7 | Dokumentation + Kommunikation | Technische Dokumentation
Den ganzen Eisberg im Blick – Planung in der Technischen Dokumentation
Technische Dokumentation – das heißt Texte, Grafiken und Übersetzungen erstellen... und noch viel mehr, davor und danach.
Um effizient und nachhaltig anspruchsvolle Technische Dokumentation zu erstellen, muss man die Prozesse entlang des gesamten Dokument-Lebenszyklus‘ berücksichtigen. Das schließt auch den gezielten Einsatz von Software-Tools ein, um die Realisierung von Prozessen in Dokumentationsprojekten zu unterstützen.
Die Stunde Null für ein Projekt der Technischen Dokumentation schlägt, wenn die Entwicklung eines Produkts beschlossen wird. Bereits von diesem Zeitpunkt an entstehen Informationen, die für die Beschreibung des Produkts potentiell relevant sind: Informationen zu Anforderungen, Nutzungsverhalten, speziellen technischen Lösungen, vorauszusehenden Problemen etc.
Diese Informationen müssen erfasst werden, und das möglichst in einer Form, die eine gute Basis für die Weiterverarbeitung bietet. Schon hier wird also die Frage nach dem angemessenen Einsatz eines Software-Tools wichtig.
Realistischerweise muss man damit rechnen, dass z.B. Produktentwickler in dieser frühen Phase eher selten (und eher unwillig) umfangreiche Text- oder Grafikdateien nach formalen und inhaltlichen Standards erstellen werden.
Vorteile von Mindmaps
Sehr nützlich sind hier Mindmaps, mit deren Hilfe man die unterschiedlichsten informationsrelevanten Materialien einfach, aber in strukturierter Form zusammenstellen kann: von Scans handgeschriebener Zettel über abfotografierte Whiteboards oder Videoclips eines Prototypen bis hin zu Programmcodes, Check-Listen und weiteren „klassischen" Dateien der Office-Welt.
Eine solche Mindmap bildet eine ideale Basis für alle weiteren Planungs- und Bearbeitungsschritte. Während des Projekts können alle Projektbeteiligten sie bearbeiten und Informationen zu inhaltlichen oder projekt-technischen Aspekten einbinden. So kann man im Rahmen einer Mindmap die Fachinhalte für ein Dokumentationsprojekt speichern und im Zusammenhang aufbauen. Außerdem dokumentiert die Mindmap den jeweils aktuellen Projektfortschritt in visuell ansprechender Form für alle „Stakeholders", d.h. alle am Projekt Beteiligten und Interessierten.
Planung lohnt sich
Sinnvollerweise sollte schon in dieser frühen Phase die gesamte Dokumentation für das Produkt geplant werden. Je früher und gründlicher die Planung geschieht, desto geringer wird am Schluss der Gesamtaufwand sein, und desto höher die Wahrscheinlichkeit einer guten Qualität.
Ähnlich wie bei der sog. Zehnerregel der Fehlerkosten im Produktbereich, steigt der Aufwand für eine Maßnahme in der Dokumentation um ein Vielfaches, wenn man sie erst in einer relativ späten Phase erkennt und durchführt. Wenn man erst kurz vor Produkteinführung daran denkt, dass man auch noch eine umfangreiche Nutzerdokumentation erstellen muss, bekommt man nicht nur akute Terminschwierigkeiten. Es werden dann auch die erforderlichen Informationen nur mit größerem Aufwand zu beschaffen sein, wenn sie z.B. nicht nachvollziehbar festgehalten wurden, und Wissensträger nur schwer oder vielleicht gar nicht mehr verfügbar sind. Oder wenn man erst Last-minute feststellt, dass es auch Übersetzungen in verschiedene europäische Sprache geben muss, wird die Übersetzung durch Lieferantenengpässe und/oder Eil-Aufschläge voraussehbar teurer werden.
Es zahlt sich also aus, so früh wie möglich mit der umfassenden Planung der Dokumentation für ein Produkt zu beginnen.
Zu dieser Planung gehört neben der klassischen Ressourcen-, Termin- und Budgetplanung auch die umfassende Spezifikation der Technischen Dokumentation. Dazu müssen die relevanten qualitativen und quantitativen Aspekte der Erstellung festgelegt werden, wie Zielgruppen, Formate, Sprachen, Visualisierungen, Umfänge. Aber auch Aspekte der Veröffentlichung und der Pflege sollten hier schon berücksichtigt werden, wie z.B. Verteilerkreise oder das Vorgehen bezüglich Updates. Die Planung kann dabei auf Basis standardisierter Vorgehensweisen erfolgen, wie sie z.B. in einem Redaktionsleitfaden festgehalten sind, oder es wird projektweise nach den individuellen Bedingungen geplant. Wichtig ist in jedem Fall, dass auch wirklich der gesamte Dokument-Lebenszyklus gleich von Anfang an berücksichtigt wird.
Direkt an die Planung schließt sich dann die Recherche für das konkrete Projekt an. Sämtliche relevanten Informationen müssen identifiziert und eingeholt werden. Quellen dafür können Objekte wie Datenbanken, andere Dokumentationen etc. sein. Wenn erforderlich, müssen Informationen auch direkt von den zuständigen menschlichen Wissensträgern wie Entwickler, Prüfer, Wartungspersonal, Produktmanager etc. eingeholt werden.
Danach folgt die eigentliche Erstellung. Der Schwerpunkt liegt dabei meistens auf der Erstellung von Texten. Dabei können „klassische" Textkapitel produziert werden, oder Textmodule, die dann entsprechend zu Rahmendokumentationen zusammengestellt oder in verschiedene Formate eingebunden werden, wie z.B. in Online-Hilfen oder FAQs. Hinzu kommen die üblicherweise mit speziellen Editoren erstellten Grafiken und ggf. weitere visuelle Formate wie Animationen, Utility Films (Video-Clip-Sequenzen) etc.. Wenn weitere Sprachversionen erforderlich sind, müssen auch die entsprechenden Übersetzungen durchgeführt bzw. beauftragt werden.
Auf keinen Fall vergessen werden dürfen dabei die erforderlichen Korrekturprozesse. Hierzu muss eine Reihe von Parametern festgelegt werden, von der Benennung der Fachexperten für die Prüfung der verschiedenen Aspekte der Dokumentation, über den genauen Ablauf der Korrekturläufe bis zu den Formalitäten der Freigabe.
Dabei sind auch verschiedene Aspekte zur Veröffentlichung der freigegebenen Dokumentation zu bedenken: Welche Formate werden den Nutzern zur Verfügung gestellt? Wie, d.h. über welche Kanäle und Plattformen, werden sie den Nutzern zur Verfügung gestellt? Was ist der Verteilerkreis bzw. was sind die verschiedenen Verteilerkreise für verschiedene Teile der Dokumentation?
Wie bleibt die Dokumentation aktuell?
Mit der Erstellung und der Veröffentlichung ist der Lebenszyklus der betroffenen Dokumente noch lange nicht am Ende. Ein wichtiger Aspekt, der von Anfang an eingeplant werden sollte, ist die Pflege der Dokumentation. Insbesondere bei sich rasch ändernden Produkten wie Software muss das Vorgehen bezüglich von Updates von Anfang an festgelegt werden: Werden sie regelmäßig oder nach Bedarf erstellt, nach welchen Kriterien, in welchem Format, wie und an wen werden sie verteilt etc..
Überlegungen zur Aktualisierung werden in Zukunft noch wichtiger werden für neue, interaktive, offenere Formen der Technischen Dokumentation, wie z.B. moderierte User-Foren. Für solche Formen ist es besonders wichtig, dass die für die Technische Dokumentation relevanten Informationen in strukturierter, aber auch flexibler Form jederzeit in ihrer aktuellsten Version zur Verfügung stehen.
Und schließlich muss auch die geeignete Archivierung eines Dokuments geplant werden. Diese erfolgt idealerweise im Rahmen eines unternehmensweiten Archivierungskonzepts oder muss ansonsten individuell festgelegt werden. Dabei kann es z.B. Fälle geben, in denen bestimmte Dokumente nach spezifischen Kriterien aktiv aus dem Verkehr gezogen werden müssen. Außerdem sind gesetzliche Bestimmungen z.B. zur Aufbewahrungspflicht ebenso zu berücksichtigen wie noch zu erwartender Bedarf ggf. auch für ältere Dokumentversionen durch Kunden, Wartungspersonal etc..
Um diese vielfältigen, komplexen Prozesse angemessen zu unterstützen, gibt es eine Vielzahl von Software-Tools.
„Angemessen" bedeutet dabei: Genau an die Erfordernisse angepasst. Also: Genügend aber nicht zu viel. Die Nutzung geeigneter Software-Tools kann die Arbeit sehr erleichtern und die Qualität verbessern. Der Einsatz ungeeigneter oder schlecht angepasster Tools kann aber auch zusätzliche Aufwände schaffen und eigene, neue Fehlerquellen produzieren.
An einem Ende der Skala steht dabei ein individuelles Vorgehen mit einem Strauß unterschiedlicher, lokal optimierter Software-Lösungen. Am anderen Ende der Skala findet sich z.B. ein unternehmensweites Software-System, das die Anforderungen aller Beteiligten abbildet.
Wo genau auf dieser Skala ein Unternehmen seine Software-Unterstützung für die Technische Dokumentation sucht, hängt ab von Faktoren wie Unternehmensgröße, Komplexität der Produkte, von der im Unternehmen vorhandenen „Software-Landschaft" etc..
Hier eine umfassende optimale Lösung zu finden, ist von der Analyse der Anforderungen bis zur Einführung und zur Unterstützung der Nutzer ein großes Projekt.
Und falls Sie überlegen, ein solches Projekt zu starten, schließt sich der Kreis mit der Empfehlung vom Anfang: Frühzeitig planen und Mindmaps nutzen!