technische Dokumentation – Qualität vom Spezialist

effiziente Unternehmensführung für größeren Erfolg

effiziente Unternehmensführung für größeren Erfolg

Gute technische Dokumentation ist Grundlage für Vertrieb und Zertifizierung, aber auch im täglichen Betrieb unerlässlich. Die Erstellung von Dokumentation dagegen wird oftmals als Qual beschrieben und kaum jemand überarbeitet oder erneuert einmal erstellte Dokumente freiwillig.

 

Was beinhaltet eine technische Dokumentation?

Auf https://www.gds.eu/de/technische-dokumentation.html findet sich eine gute Übersicht, welche Prozessschritte involviert sind und was davon externe Dienstleister übernehmen können. Unter die technische Dokumentation fallen Bedienungsanleitungen, FAQs für den Helpdesk, Betriebsanleitungen, Handbücher, Installationsanleitungen u.v.m. Grundsätzlich kann man sagen, alles was das Produkt beschreibt, spezifiziert, für die Konstruktion und Herstellung wichtig ist, das Vorgehen der Qualitätssicherung sind Punkte, die in der technischen Dokumentation abgelegt werden sollten.

Normen und Anforderungen

Die eine Norm für technische Dokumentationen gibt es nicht. Je nach Branche gibt es relevante ISO, DIN, ANSI Normen die beachtet werden müssen. Nutzen Sie einen Dienstleister für die Erstellung und Pflege wird dieser ihnen die relevanten Normen nennen und prüfen, ob die aktuelle Dokumentation die Anforderungen erfüllt. In vielen Bereichen muss die Dokumentation dem Kunde, in einigen Fällen, sogar jedermann offen zugänglich sein. Nicht nur die Zugänglichkeit muss beachtet werden, sondern auch die Sprachanforderungen. Aus welchen Ländern kommen Kunden, Servicedesk, Entwickler und Anwender? Je Dokument sollte über die Verständnisebene nachgedacht werden. Dokumente für Entwickler dürfen detaillierter und in Fachsprache verfasst sein, während Endkundendokumente einfach und leicht verständlich gehalten werden sollen.

Werkzeuge

Die meisten Dokumentationen werden nach wie vor in Word oder einem anderen Textverarbeitungsprogramm erstellt. Für die professionelle Dokumentationserstellung gibt es inzwischen aber spezielle Software, die die Arbeit erleichtert. Unterstützung bieten sie insbesondere bei Versionskontrolle und Revisionssicherheit. Sie unterstützen bei der Erstellung  der Texte und der Verwaltung von Bildern und Zeichnungen. Intelligente Verlinkung, automatisches Einfügen von Fußnoten und Begriffserklärungen ermöglichen die Nutzung von bereits erstellten Inhalten und führen zur Verwendung immer derselben Terminologie. Ähnlich wie beim Corporate Branding führen Sie mit einer einheitlichen Terminologie eine klare, eindeutige Sprache ein, die der Kunde wiedererkennt und gewohnt ist.

externe Prüfung der Dokumentation

In manchen Branchen gibt es Vorschriften, die eine regelmäßige Prüfung wichtiger Dokumente erfordern. Wer eine hohe Qualität sicherstellen möchte, sollte grundsätzliche eine solche Prüfung durchführen, nur so kann sichergestellt werden, dass im Fall einer kurzfristigen Prüfung, Neukundengewinnung oder im Notfall schnell die richtige Information zur Verfügung steht. Einige Dokumentationsdienstleister verleihen Gütesiegel für geprüfte Dokumentationen, welche wiederum bei der Neukundenakquise helfen können. Mit geprüfter Dokumentation machen Sie Ihren eigenen Anspruch nach hohen Qualitätsstandards nach Außen sichtbar.

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.

scroll to top