10 FAQ zur Technischen Dokumentation

Haben Sie noch wenig Erfahrung mit dem Erstellen oder Erstellenlassen einer Technischen Dokumentation? Nachfolgend finden Sie Antworten auf die häufigsten Fragen, die in diesem Zusammenhang entstehen.

Welche Dokumente fallen überhaupt unter den Begriff „Technische Dokumentation“?

Der Begriff „Technische Dokumentation“ umfasst allgemein alle Unterlagen, die erforderlich sind, um ein Produkt oder System und dessen Verwendung vollständig zu beschreiben – sowohl aus technischer als auch aus betrieblicher Sicht.

Eine Technische Dokumentation kann sowohl intern innerhalb des herstellenden Unternehmens benötigt werden als auch extern für Partner, Kunden oder Behörden.

• Bei einem internen Gebrauch stellt die Technische Dokumentation sicher, dass ein Produkt erfolgreich weiterentwickelt werden kann und das dazu benötigte Wissen und getroffene Festlegungen nicht vergessen werden oder verloren gehen, wenn Mitarbeiter das Unternehmen verlassen.
• Bei einem externen Gebrauch stellt die Technische Dokumentation sicher, dass ein Produkt gefahrlos und in vollem Umfang von dessen Nutzern verwendet werden kann. Unter Umständen gibt es außerdem bestimmte gesetzliche oder vertragliche Anforderungen, die ein schriftliches Festhalten bestimmter Informationen oder Daten fordern.

Im engeren Sinne fallen unter den Begriff „Technische Dokumentation“ insbesondere: Benutzerhandbücher, Onlinehilfen, Montageanleitungen, Installationsanleitungen, Betriebsanleitungen, Wartungsanleitungen, Reparaturanleitungen, Fehlerbehebungsleitfäden, Quellcode-Dokumentationen, API-Dokumentationen (Schnittstellenbeschreibungen), Datenblätter, Ersatzteilkataloge, Verpackungsanweisungen, Transportanweisungen, Release Notes und vergleichbare Dokumente.

Welche Anforderungen muss eine Technische Dokumentation erfüllen?

Letztlich zielen alle wesentlichen Anforderungen an eine externe Technische Dokumentation darauf ab, die Nutzer eines Produkts in die Lage zu versetzen, das Produkt vollumfänglich und sicher verwenden zu können. Um dies zu gewährleisten, wurden zahlreiche Anforderungen in diversen Normen und Standards festgelegt. Darüber hinaus bestehen in einigen Fällen auch gesetzlich geregelte Anforderungen.

Weitere Anforderungen ergeben sich aus dem Erstellungs- und Pflegeprozess einer Technischen Dokumentation über deren gesamten Lebenszyklus.

Siehe zu diesem Thema auch die ausführlicheren Informationen unter: Anforderungen an eine Technische Dokumentation.

Muss eine Technische Dokumentation gedruckt werden oder genügt auch eine Onlinedokumentation?

Bisher galt: Mit Ausnahme von Softwaredokumentation muss in Europa eine Technische Dokumentation grundsätzlich auch in gedruckter Form auf Papier zusammen mit dem Produkt in physischer Form ausgeliefert werden. Eine rein elektronische Dokumentation reichte nicht aus.

Aktuell ist in diese Debatte Bewegung geraten und auch die Behörden erkennen langsam den Wandel der Zeit. Die vorstehende Aussage gilt daher heute nicht mehr uneingeschränkt. In den meisten Fällen müssen heute zumindest nicht mehr alle Informationen auf Papier gedruckt geliefert werden.

Um die Frage im Detail beantworten zu können, ist jedoch ein genauer Blick auf den Einzelfall erforderlich und gegebenenfalls auch eine Beratung durch einen Juristen.

Welche Besonderheiten gibt es im Bereich Softwaredokumentation?

Anders als Technische Dokumentation im Maschinen- und Anlagenbau wurde die Softwaredokumentation stark durch US-amerikanische Unternehmen geprägt. Aspekte der Produktsicherheit sind hier hier oft weniger zentral als bei einer Hardware-Dokumentation, da mit der Bedienung von Software in den meisten Fällen keine unmittelbaren gesundheitlichen oder lebensbedrohenden Gefährdungen ausgehen. Fragen rund um Sicherheitshinweise und Normenkonformität einer Technischen Dokumentation spielen daher bei einer Softwaredokumentation nur eine untergeordnete Rolle.

Naturgemäß ist im Bereich Softwaredokumentation das Thema Onlinedokumentation besonders wichtig. Sie ist bei Software heute Stand der Technik. Da Nutzer eine Onlinedokumentation anders verwenden und lesen als eine gedruckte Betriebsanleitung, sind hier auch die strukturellen und didaktischen Anforderungen anders.

Außerdem sind bei einer Software die Aktualisierungszyklen meist deutlich kürzer als bei einem physischen Produkt (Hardware). Nicht selten gibt es bei einer Software alle paar Wochen ein neues „Release“. Dementsprechend muss auch die Technische Dokumentation zu einer Software häufiger aktualisiert werden als die Technische Dokumentation zu einer Hardware. Seitens der Erstellungswerkzeuge und -prozesse erfordert dies einen höheren Automatisierungsgrad, um wirtschaftlich arbeiten zu können.

Wer erstellt eine Technische Dokumentation?

Empfehlenswert ist in den meisten Fällen die Erstellung durch erfahrene Technische Redakteure. „Technische Dokumentation“ ist heute ein mehrjähriger Studiengang an einer Hochschule und erfordert spezielle Kompetenzen, wenn am Ende alles möglichst einfach erscheinen und wie selbstverständlich wirken soll.

Die Praxis sieht allerdings oft anders aus: In der Realität wird ein großer Anteil an Technischer Dokumentation von Personen erstellt, die dazu weder wirklich qualifiziert sind, noch daran Spaß haben. Häufig bleibt das Schreiben von Handbüchern als ungeliebte Aufgabe an Entwicklern oder Produktmanagern hängen. Dies hat zwar den Vorteil einer großen Expertise in der fachlichen Domäne des Produkts, aber genau das wird letztlich oft zum Problem: Diese Autoren setzen beim Leser nicht selten zu viel an Vorwissen voraus und es fällt ihnen schwer, sich in Außenstehende ohne dieses Vorwissen zu versetzen.

Gelegentlich wird das Erstellen einer Technischen Dokumentation auch an Werkstudenten oder Bürokräfte delegiert. Dies erscheint auf den ersten Blick kostengünstig, wird Ihre Kunden am Ende aber in den wenigsten Fällen überzeugen und ist damit letztlich oft die teuerste Lösung.

Wo finde ich einen Dienstleister zum Erstellen einer Technischen Dokumentation?

Falls Sie nicht in der glücklichen Lage sind, auf eine persönliche Empfehlung zurückgreifen zu können, eignet sich neben einer Recherche im Web insbesondere die Website des Branchenverbands tekom als Startpunkt für die Suche. Auf der Website der tekom gibt es unter anderem eine auf Technische Dokumentation spezialisierte Dienstleisterdatei.

Siehe außerdem auch die Tipps unter: Dienstleister für Technische Dokumentation finden: Wer passt zu Ihnen?.

Wie lange dauert das Erstellen einer Technischen Dokumentation?

Wie viel Zeit Sie einplanen müssen, bis eine Technische Dokumentation erstellt ist, hängt stark vom zu beschreibenden Produkt ab und davon, wie viel Vorwissen dessen Nutzer mitbringen. Ein bedeutender Faktor kann auch das Anfertigen von Abbildungen sein: Wenn Sie mit Screenshots, Fotos oder vorhandenen CAD-Daten arbeiten können, geht es deutlich schneller, als wenn viele aufwendige Grafiken neu entworfen werden müssen. Da Screenshots meist der am einfachsten zu erstellende Abbildungstyp sind, liegen die Erstellungszeiten bei einer Softwaredokumentation in der Regel spürbar unter denen einer Hardwaredokumentation. Bei einer Neuerstellung einer Technischen Dokumentation bewegt sich der Aufwand einschließlich Konzept und Layout-Entwicklung letztlich in Summe irgendwo zwischen 1,5 bis 3 Stunden pro Seite.

Wichtig: Eine gute Technische Dokumentation ist möglichst kurz, denn dann kostet sie Ihre Kunden wenig Zeit beim Lesen und lässt die Bedienung Ihres Produkts einfach erscheinen. Informationen kurz und prägnant darzustellen, ist jedoch sehr anspruchsvoll. Dies führt in der Praxis dazu, dass es länger dauert, eine Information kompakt auf einer Seite darzustellen als schnell und gedankenlos 2 oder 3 Seiten damit zu füllen.

Messen Sie daher die Produktivität niemals nach Seiten oder Textmenge. Weniger ist oft mehr! Bezahlen Sie daher einen Technischen Redakteur auch niemals nach der Anzahl geschriebener Seiten. Damit bestrafen Sie gute Arbeit.

Was kostet das Erstellen einer Technischen Dokumentation?

Analog zum Zeitbedarf hängen auch die Kosten für das Erstellen einer Technischen Dokumentation stark vom jeweiligen Produkt und dessen Zielgruppe ab. Wenn Sie den durchschnittlichen Zeitbedarf von 1,5 bis 3 Stunden pro Seite mit Ihrem internen Stundensatz oder mit dem Stundensatz eines Dienstleisters multiplizieren und dies wiederum mit der geschätzt notwendigen Anzahl an Seiten, erhalten Sie einen groben Anhaltspunkt.

Übrigens: Falls Sie in einem Unternehmen angestellt sind, dürfen Sie zur Ermittlung Ihres eigenen fiktiven Stundensatzes nicht einfach Ihr Gehalt durch die Anzahl Ihrer Arbeitsstunden teilen. Sie müssen auch die Kosten Ihres Arbeitsplatzes berücksichtigen (Gebäude, Möbel, Computer, Software, Heizung, Strom, Versicherungen …). Außerdem anteilig die Kosten und Zeiten für administrative Tätigkeiten, Meetings, Weiterbildung sowie krankheitsbedingte Fehlzeiten, wodurch Ihr interner Stundensatz deutlich höher liegt. Eventuell können Sie von Ihrer Personalabteilung oder vom Controlling genauere Zahlen erhalten.

Falls Ihnen die Kosten für das Erstellen einer umfassenden Technischen Dokumentation hoch erscheinen: Vergleichen Sie diese Kosten einmal mit den Kosten, die in die Entwicklung Ihres Produkts fließen. Meist relativiert das dann die Dinge sehr schnell. Letztlich gehört außerdem auch die Entwicklung der Dokumentation zur Entwicklung Ihres Produkts.

Mit welchen Software-Programmen wird eine Technische Dokumentation am besten erstellt?

De facto wird der größte Anteil an Technischer Dokumentation noch immer mit Microsoft Word erstellt. Der Hauptgrund dafür ist einfach nur, dass das Programm ohnehin bereits im Haus im Einsatz ist. Wirtschaftlich sinnvoll ist diese Entscheidung freilich in den seltensten Fällen. Sie verpassen damit viele extrem zeitsparende Möglichkeiten, die auf das Erstellen einer Technischen Dokumentation spezialisierte Programme und Redaktionssysteme bieten:

• Trennung von Layout und Inhalt: Autoren können sich voll auf den Inhalt konzentrieren. Um das Layout kümmert sich die Software. Außerdem lässt sich das Layout auch später noch jederzeit ändern, ohne dass dazu die Texte angefasst und neu formatiert werden müssen.
• Mehrfachverwendung von Inhalten: Sie können einmal erstellte Inhaltsbausteine beliebig oft wiederverwenden. So erstellen Sie z. B. ein Impressum oder häufig benötigte Warnhinweise nur ein einziges Mal. Wenn Sie den Text später ändern müssen, ändern Sie ihn an zentraler Stelle. Alle Dokumente, die Sie ab diesem Zeitpunkt neu generieren, erhalten dann automatisch an allen Stellen die neue Version des Inhaltsbausteins.
• Single Source Publishing: Aus derselben Quelle können Sie auf Knopfdruck die Dokumentation in unterschiedlichen Ausgabeformaten generieren: z. B. sowohl als druckbares Handbuch im PDF-Format als auch als HTML-basierte Onlinedokumentation. Außerdem können Sie bei Bedarf aus derselben Quelle eine Technische Dokumentation in unterschiedlichen Varianten ausgeben, beispielsweise als Dokumentation für eine Standard-Version eines Produkts und als Dokumentation für eine Professional-Version desselben Produkts. Oder für unterschiedliche Zielgruppen oder Branchen. Oder als OEM für unterschiedliche Kunden in einem komplett anderen Design.
• Linkmanagement: Querverweise erstellen Sie komfortabel per Drag and Drop. Falls Sie später Inhalte ändern, verschieben oder löschen, passt das Redaktionssystem automatisch im Hintergrund alle Querverweise an und sorgt dafür, dass keine Brüche entstehen.
• Versionsverwaltung: Sie können jederzeit auf frühere Stände der Technischen Dokumentation eines Produkts noch zugreifen. In einer Datenbank ist lückenlos dokumentiert, welche Person zu welchem Zeitpunkt welche Änderung an der Dokumentation vorgenommen hat.
• Workflows: Falls Sie in größeren Teams arbeiten, können Inhalte einen stufenweisen Prozess durchlaufen, von der Erstellung über Korrekturen bis zur Freigabe, Übersetzung und Publikation.
• Review-Prozess: Personen, die einen Text gegenlesen, können im System Anmerkungen hinterlassen. Andere Personen sowie die Autoren können diese Anmerkungen direkt an der richtigen Stelle sehen, diskutieren und übernehmen oder zurückweisen.
• Übersetzungsmanagement: Muss eine Technische Dokumentation in eine oder mehrere Fremdsprachen übersetzt werden, können Sie direkt aus dem Redaktionssystem heraus Übersetzungspakete an die Übersetzer schicken. Nach der Übersetzung spielen Sie die Übersetzungspakete auf Knopfdruck wieder zurück. Muss nach einem Update eine Dokumentation nicht komplett neu übersetzt werden, extrahiert das System automatisch nur die geänderten Passagen, was dementsprechend Übersetzungskosten spart.
• Automatisierung: Per Knopfdruck produzieren Sie alle Dokumente in allen Varianten und Sprachen mit einem einzigen Befehl.

Redaktionssysteme für das Erstellen Technischer Dokumentationen gibt es in allen Größenordnungen und Preisklassen sowohl als Desktop-Anwendungen als auch als Software as a Service (SAS). Für das Erstellen von Onlinedokumentationen gibt es darüber hinaus auch zahlreiche OpenSource-Lösungen. Siehe hierzu auch: Help Authoring Tools und Redaktionssysteme für die Technische Dokumentation.

Wie sollte ich die Erstellung einer Technischen Dokumentation planen, und womit fange ich an?

Egal ob Sie eine Technische Dokumentation selbst erstellen oder von einem Dienstleister erstellen lassen, sollten Sie in folgenden Schritten vorgehen:

1. Definition der Zielgruppe: Halten Sie intern fest, für wen genau Sie die Technische Dokumentation anfertigen. Richten Sie alle die Technische Dokumentation betreffenden Entscheidungen an dieser Zielgruppe aus (und nicht an Ihren eigenen Präferenzen).
2. Analyse der Wissenslücken: Ermitteln Sie anhand der zuvor definierten Zielgruppe das Delta zwischen dem, was diese Personen bereits an Vorwissen mitbringen und dem, was sie zur Nutzung des Produkts wissen müssen.
3. Strukturentwurf: Definieren Sie die benötigten Informationsbausteine (sog. „Topics“), und bringen Sie diese Topics in eine didaktisch sinnvolle Reihenfolge und übersichtliche, möglichst flache Struktur.
4. Redaktion: Schreiben Sie die zuvor definierten Topics. Dabei ist der Strukturentwurf nicht in Stein gemeißelt, bietet aber eine Leitschnur. Sie werden immer wieder feststellen, dass noch Informationen fehlen oder im Detail eine andere Struktur besser geeignet ist. Dennoch ist es wichtig, bereits mit einem ersten Strukturentwurf zu starten und nicht vollkommen ins Blaue drauflos zu schreiben. (Das geht zwar auch, kostet in Summe aber IMMER mehr Zeit.)
   Tipp: Schreiben sie einleitende, überblicksartige Informationen möglichst spät, auch wenn diese Informationen im Dokument typischerweise weit vorne stehen! Zwar sind diese Inhalte vermeintlich „einfach“, erfordern jedoch den besten Überblick über das Produkt und sind didaktisch am anspruchsvollsten aufzubereiten. Oft ist es am besten, beim Schreiben mit referenziellen Informationen zu beginnen, wie mit Parameterbeschreibungen und technischen Daten. Danach machen Sie dann weiter mit dem Schreiben schrittweiser Anleitungen und erst ganz spät schreiben Sie solche Inhalte, die das mentale Modell des Produkts vermitteln und Nutzern dabei helfen, die Logik des Produkts zu verstehen (Konzepte).
5. Review: Es sollte immer eine zweite Person jeden Text gegenlesen – sowohl aus fachlicher Sicht als auch redaktionell. Auch bei größter Sorgfalt ist JEDER Autor blind für viele seiner eigenen Fehler!
   Tipp: Wenn absolut keine zweite Person verfügbar ist, kann es helfen, sich als Autor seinen Text von einer Software vorlesen zu lassen. Sie werden staunen, wie viele Fehler Sie hören, die Sie im geschriebenen Text gar nicht sehen. Auch ein Ausdruck auf Papier kann helfen, Fehler zu finden, für die Sie am Bildschirm schlicht blind sind.
6. Einarbeiten von Korrekturen: Beim Einarbeiten der aus dem Review folgenden Änderungen und Korrekturen ist besondere Sorgfalt gefordert, um nicht in den überarbeiteten Dingen neue Fehler zu machen, die dann niemandem mehr auffallen. Üblicherweise erfolgt danach keine weitere Korrektur.
7. Layoutkontrolle und Produktion: Haben alle Texte und sonstigen Inhalte den finalen Stand erreicht, sollten Sie das Dokument noch einmal im endgültigen Layout betrachten. Danach können Sie dann die Dokumentation in der Quellsprache bereits publizieren.
8. Übersetzung: Im letzten Schritt folgt gegebenenfalls noch die Übersetzung der Technischen Dokumentation in weitere Sprachen. In der Praxis wird für diesen Schritt häufig die Zeit genutzt, in der sich das Produkt intern noch in einer letzten Testphase befindet.

Tipp: Nicht alle Kapitel in einer Technischen Dokumentation sind gleich wichtig. Fast immer gibt es bei einem Produkt einige wenige Funktionen, die Nutzern besonders häufig Probleme bereiten. Dementsprechend werden die betreffenden Themen der Dokumentation viel häufiger gelesen werden als andere Themen. Verwenden Sie besonders viel Zeit und Sorgfalt auf solche Themen, die:

• besonders häufig gelesen werden
• über Erfolg und Misserfolg entscheiden
• bereits am Anfang der Nutzung eines Produkts gelesen werden, während Sie noch die Chance haben, die Nutzer von Ihrem Produkt und vom Wert der Technischen Dokumentation zu begeistern

Bei allen anderen Themen können Sie den Erstellungsaufwand dafür etwas geringer halten. Auf diese Weise nutzen Sie ein begrenztes Budget an Zeit und Kosten in Summe am wirkungsvollsten!