Markus Müller am 15. August 2016 —

Technische Dokumentation: Mehr als eine Gebrauchsanleitung

Mit der Einführung eines neuen Produkts fallen viele Arbeitsschritte an. Das Produkt muss sorgfältig geplant werden und jeder Entwicklungsschritt wird genau untersucht. Wenn das Produkt fertiggestellt und bereit für die Markteinführung ist, sollte der Entwickler beachten, dass er die technische Dokumentation des Produktes sorgfältig durchführt. Der Gesetzgeber fordert eine ausführliche technische Dokumentation um die Sicherheit und die fachgerechte Bedienung des Produktes zu gewährleisten. Mit der technischen Dokumentation hilft man nicht nur dem Benutzer des Produkts, sondern sichert sein Unternehmen vor möglichen rechtlichen Angriffen ab. So steigert man nicht nur die Kundenzufriedenheit, sondern senkt das Haftungsrisiko. Lesen Sie weitere Informationen bei Global Document System.

Interne und externe technische Dokumentation

manualMan kann bei einer technischen Dokumentation zwischen einer internen und einer externen Dokumentation unterscheiden. Die interne technische Dokumentation dient dem Unternehmen selbst. Sie umfasst alle Schritte der Entwicklung des Produkts und den Produktlebenszyklus. Wichtig ist hierbei, dass alle wichtigen Dokumente archiviert werden, um eine langfristige rechtliche Absicherung zu gewährleisten. Dazu zählen beispielsweise, Versuchsberichte, Berechnungsunterlagen, technische Zeichnungen und Nachweise über die Qualitätssicherheit.

Die externe technische Dokumentation ist für den Kunden, beziehungsweise für den Benutzer des Produktes gedacht. Damit soll sichergestellt werden, dass der Nutzer das Produkt sachgerecht in Betrieb nimmt und bei eventuellen Problemen erst einmal in der Dokumentation nachlesen kann. Im Regelfall wird die technische Dokumentation für den Kunden von speziellen Redakteuren verfasst. Wenn das Produkt auf internationalen Märkten verkauft wird, müssen die Texte fachgerecht in die jeweiligen Sprachen der einzelnen Länder übersetzt werden. Innerhalb Europas sind dies beispielsweise Englisch, Spanisch, Polnisch und Schwedisch. Die externe technische Dokumentation ist je nach Produkt und Zielgruppe besser unter Bedienungsanleitung, Gebrauchsanweisung oder Benutzerhandbuch bekannt.

Die professionelle Arbeit bei der Erstellung einer Dokumentation ist besonders wichtig. Trotz verwendeter Fachsprache sollte der Nutzer wenige Probleme haben, die Bedienungsanleitung zu verstehen. Neben der Verständlichkeit der Texte müssen selbstverständlich Stil- und Grammatikregeln eingehalten werden. Zusätzlich zu der Standard Dokumentation auf Papier, die jedem Produkt beiliegt, ist es sinnvoll auch online Versionen für den Kunden bereitzustellen. Dies erspart dem Nutzer langes Suchen, falls die originale Anleitung verloren gegangen ist. Die Zusammenarbeit mit einem professionellen Redaktionssystem bei der Erstellung der Dokumentation hat viele Vorteile. Die Redakteure sind perfekt auf das Schreiben von solchen Texten geschult und sind sicher im Schreibstil. Sie erkennen wichtige Informationen und können diese effizient als Dokument zusammenfassen. Durch den Einsatz von externen Schreibern spart man sich Kosten und Zeit. Des Weiteren kann man sich sicher sein, dass die Dokumentation nach allen gängigen Richtlinien und Vorgaben umgesetzt wird.

Diskussion

Kommentare abonnieren (RSS)
2 Kommentare zu „Technische Dokumentation: Mehr als eine Gebrauchsanleitung“.

  1. Für mich als Einzel-Entwickler (Software) ist das lästige Erstellen der Dokumentation auch eine Möglichkeit, mein Programm (ein weiteres Mal) aus der Sicht des späteren Benutzers zu betrachten.

    Es sollten also möglichst Erkenntnisse aus der Phase der Dokumentations-Erstellung in das Produkt einfließen können; denn oft erkennt man erst, wenn man einem Laien sein Produkt erklären will oder muß, an welchen Stellen es hakt, und was vielleicht viel zu kompliziert gelöst wurde.

    Bei größeren Unternehmen braucht es dazu also eine Feedback-Möglichkeit der Anleitungs-Schreiber an die Entwickler.
    Bzw., man sollte die Sicht der Anleitungs-Verfasser schon möglichst früh in den Entwicklungs-Prozeß einbeziehen.

  2. Ich habe erst kürzlich einen echten Megaflop mit mangelnder Doku erlebt: Einen an sich tollen Verdampfer/Tank für meine E-Dampfe gekauft, doch war nicht beschrieben, wie der Liquid-Abfluss und Zufluss geregelt wird. Ich hab das Teil zurück geschickt, weil ich es oben „verschlossen“ fand – obwohl es doch ein Topfiller sein sollte! Bekam das Teil dann zurück und siehe da: wo eben noch alles zu war, sah ich auf einmal Löcher… alles ok?
    Keineswegs! Die Einfülllöcher waren beim nächsten Versuch wieder verschwunden… Kurzum: es dauerte lange, bis ich der Sache auf die Spur kam. Das Teil hatte eine wirklich geniale Mechanik, um diese Zuflusslöcher zu öffnen und zu schließen. Nur leider gar nicht selbsterklärend und NICHT DOKUMENTIERT!
    Ergebnis: das Produkt wird derzeit verramscht.. klar, kommt ja niemand problemlos damit zurecht…