Bitte warten - Ihr Zugang wird eingerichtet.

WeiterbildungSo schreiben Sie erfolgreich technische Dokumentationen

Fachwissen um die Erstellung von technischen Dokumentationen ist heute gefragt - das Verfassen von solchen will gelernt sein! Hier finden Sie fünf Tipps, wie Ihnen die Erstellung von Bedienungsanleitungen, Betriebsanleitungen und Co. gelingt.

Von der Bedienungsanleitung bis zum Softwarehandbuch: Für die Erstellung einer technischen Dokumentation ist Fachwissen gefragt © FH JOANNEUM
 

Bezahlte Anzeige
Zunächst grundlegend – was versteht man unter einer „technischen Dokumentation“? Der Begriff bezieht sich auf ein Informationsprodukt, welches zur sicheren und richtigen Verwendung, wie auch Wartung oder Reparatur eines technischen Erzeugnisses anleitet. Einfacher ausgedrückt: In den Sammelbegriff „technische Dokumentation“ fallen zum Beispiel Bedienungsanleitungen, Betriebsanleitung, Softwarehandbücher oder Service-Anweisungen. Also Informationen, welche Sie als Hersteller der Öffentlichkeit übermitteln. Klingt kompliziert? Tatsächlich ist einiges an Fachwissen gefragt! In der Berufswelt wird diese Qualifikation jedoch zunehmend nachgefragt – sich in diesem Bereich weiterzubilden macht sich daher bezahlt! Hier im Überblick die wichtigsten Punkte, die Sie zur Erstellung berücksichtigen müssen:

Qualifizierte Technische Redakteurinnen und Technische Redakteure werden in allen Industriezweigen stark nachgefragt Foto © FH JOANNEUM

Ist Ihre Dokumentation normgerecht?

Eine technische Dokumentation unterliegt – wie sollte es anders sein – gesetzlichen Anforderungen und Normen. Diese zu kennen ist daher der allererste Schritt, bevor Sie mit der konkreten Erstellung Ihrer Dokumentation beginnen sollten. Tatsächlich ist eine technische Dokumentation für Sie auch als rechtliche Absicherung notwendig – eine normgerechte Dokumentation gilt als Entlastungsbeweis bei Produkthaftungsklagen und Gewährleistungsfällen. Eine Grundlage bietet etwa die ÖVE/ÖNORM EN 82079 vom Juli 2013 bzw. in Zukunft die IEC/IEEE 82079-1 von 2019. In der ÖNORM-Richtline wird die Gliederung und Darstellung von technischen Erzeugnissen unter rechtlichen Aspekten erklärt. Zur rechtssicheren Konformitätsvermutung ist die Normenanwendung also dringend zu empfehlen. Wenn Sie jedoch nicht nur einmalig, sondern durchaus öfter eine technische Dokumentation erstellen müssen oder eine berufliche Weiterentwicklung in diese Richtung anstreben, ist eine professionelle Weiterbildung unbedingt empfehlenswert.

Vor der Erstellung Ihrer Dokumentation gilt es, sich über rechtliche Voraussetzungen in Kenntnis zu setzen Foto © Rawpixel.com

Nutzen Sie neue Medien

Wenn Sie an eine Bedienungsanleitung denken, haben Sie vermutlich automatisch eine auf Papier gedruckte Anleitung in Buch- oder Folderform im Kopf. Für Ihre technische Dokumentation gibt es jedoch noch so viel mehr mögliche Darstellungsformen. Zum Beispiel im Web oder als Audio- und Videodokumentation. Doch auch neue Medien, wie Apps, 3D Animation oder Augmented Reality können zur Darstellung gewählt werden. Wichtig ist selbstverständlich, dass das Medium für Ihr Produkt sinnvoll ist. Im besten Fall unterstützt die gewählte Form den Erläuterungsprozess.

Für Ihre Dokumentation können Sie zum Beispiel auch Augmented Reality nutzen Foto © FH JOANNEUM

Auf Ihre Zielgruppe zugeschnitten

Für eine gute technische Dokumentation gilt es, sich in Ihren Kunden zu versetzen. Betrachten Sie Ihr Produkt durch die Augen des Benutzers. Stellen Sie sich selbst die Frage: Was können Sie von Ihrer Zielgruppe an Grundwissen erwarten? Für eine hoch-komplexe Software mit einer kleinen, spezifischen Zielgruppe wird die Bedienungsanleitung anders ausfallen, als etwa für ein Bücherregal für Herrn und Frau Jedermann. Das bezieht sich sowohl auf das Wording, als auch auf die inhaltliche Tiefe und die praktische Gestaltung Ihrer technischen Dokumentation. Zielgruppenorientierter Content und Usability sind das A und O!

Bedenken Sie, dass Sie Ihre Dokumentation für eine gewisse Zielgruppe erstellen. Das beeinflusst sowohl die Wahl der Darstellungsform, als auch die Ausgestaltung Foto © FH JOANNEUM

Sprachgenau: Gut erklärt ist halb gewonnen

Auch in puncto Sprachgenauigkeit ist es entscheidend, dass Sie Ihre Zielgruppe kennen. Zugunsten des besseren Verständnisses sollten Sie zu klarer, verständlicher Sprache greifen. Berücksichtigen Sie, dass eine festgelegte Terminologie die Qualität Ihrer technischen Dokumentation steigern kann. Mit anderen Worten: definieren Sie Begriffe einheitlich – auch innerhalb Ihres Unternehmens. Das hilft dem Nutzer bei der Orientierung und ist auch bei täglichen Arbeitsprozessen hilfreich. Nebst Terminologie- ist auch Phraseologiemanagement ein wichtiger Punkt. Das heißt: Verwenden Sie Fachsprache und Fachbegriffe nicht isoliert, sondern im Kontext und vor allem: sinnstiftend und zielgerichtet! Sie als Experte sind tief in der Fachthematik verwurzelt. Berücksichtigen Sie jedoch, dass der Nutzer Ihres Produktes mit hoher Wahrscheinlichkeit über ein weniger weitreichendes Fachwissen verfügen wird.

Einheitliche Begriffsbezeichnungen führen zu einem besseren Verständnis. Legen Sie daher vor der Erstellung Ihrer technischen Dokumentation fixe Termini fest Foto © pressmaster

Nutzen Sie moderne Tools und Redaktionssysteme

Denken Sie bei der Erstellung Ihrer technischen Dokumentation auch über den Tellerrand hinaus! Sie erschaffen bei der Verfassung einer solchen nicht nur eine Bedienungsanleitung oder ähnliches für Ihre Kunden, sondern auch eine Datenbasis für Ihr eigenes, firmeninternes Wissenssystem. Damit diese Basis jedoch auch sinnvoll genutzt werden kann, ist die Verwendung von modernen Tools oder Redaktionssystemen notwendig. Überdenken Sie daher die Einführung von entsprechenden Redaktions- und Content Management Systemen. Diese erleichtern auch die Publikationsprozesse!

Technische Dokumentationen auf professionellem Niveau erstellen

Ob für Ihr eigenes Unternehmen oder als berufliche Weiterentwicklung: Das Know-How von qualifizierten technischen Redakteuren und Redakteurinnen hat in allen Industriezweigen einen hohen Stellenwert! Im Zuge des berufsbegleitenden Masterlehrganges „Technische Dokumentation“ an der FH JOANNEUM wird in drei Semestern umfassendes, praktisches Wissen vermittelt. Besuchen Sie den virtuellen Tag der offenen Tür am 29. Juli 2020 um 19 Uhr und informieren Sie sich!

Entstanden in Kooperation mit der FH JOANNEUM.

Bezahlte Anzeige