Betriebsanleitung, Montageanleitung, Wartungsanleitung und Co

Betriebsanleitungen, Montageanleitungen, Wartungsanleitungen (unter anderem) sind Bestandteile der externen Technischen Dokumentation; es handelt sich also um Dokumente, die mit dem Produkt an den Kunden geliefert werden. Sie bieten Informationen über das Produkt, über den Umgang mit dem Produkt und über das gewünschte bzw. notwendige Verhalten der Nutzer. Alle Lebensphasen des Produktes, von der Entwicklung bis zur Entsorgung, werden betrachtet.

Die externe Technische Dokumentation dient jedoch nicht nur der Information und Instruktion definierter Benutzergruppen, sondern auch der Erfüllung der Forderungen aus den EG-Richtlinien und Normen und somit der haftungsrechtlichen Absicherung des Herstellers.

Damit eine Anleitung rechtssicher und normenkonform ist, müssen folgende Dinge beachtet werden:

Aufbau und Inhalt müssen den geltenden EG-Richtlinien und produktspezifischen Normen entsprechen
Es muss eine Risikobeurteilung durchgeführt und deren Ergebnisse zielgruppengerecht vermittelt werden
Inhalte müssen den gültigen Regeln und Normen der Technischen Dokumentation entsprechend aufbereitet werden
Normative Verweise und Verweise auf technische Regeln müssen für das Ausland auf nationale Gegebenheiten übertragen werden (Lokalisierung)
Fremdsprachige Versionen einer Anleitung müssen überprüfbar und nachvollziehbar sein (Übersetzungsmanagement)

Bei der Erstellung der Dokumentation sind die Auswahl der richtigen Software, der richtige Umgang mit der Software und das passende Dokumentationskonzept inkl. Sprache, Stil und Layout sowohl kurz- als auch langfristig entscheidend für die entstehenden Kosten.

Eine weitere wichtige Rolle bei den Kosten spielt das Übersetzungsmanagement.

Weitere Informationen

Die Dokumentation ist Teil des Produkts!

Eine vollständige und alle Fälle abdeckende Endkundendokumentation wird es nie geben.

Technische Dokumentation lebt durch Kundenrückmeldungen, Produktbeobachtung, Marktbeobachtung und Produktverbesserungen.

Weitere Änderungen resultieren aus Anforderungen, die sich aus dem aktuellen Stand der technischen Dokumentation aus technologischer Sicht, sowie aus neuen Regeln zum Abfassen und Vermitteln der Informationen ergeben.

Im Übrigen müssen auch Marketingunterlagen mit der Benutzerdokumentation abgestimmt werden. Die Aussagen in Verkaufsbroschüren dürfen nicht von den Inhalten der Benutzderdokumentation abweichen.

Unsere Leistungen für Sie

Zielgruppenanalyse
Konzepterstellung
Foto- und Montagearbeiten
Inhaltserarbeitung anhand von 3D-CAD-Modellen (Reparaturvorgänge, Grafikerstellung, …)
Redaktionelle Bearbeitung
Erstellung von Grafiken und Technischen Illustrationen
Optimierung bestehender Anleitungen und Prozesse
Usability-Test