{"id":1017,"date":"2022-12-01T07:31:00","date_gmt":"2022-12-01T06:31:00","guid":{"rendered":"https:\/\/staging.lexsys.de\/?p=1017"},"modified":"2024-09-23T10:07:38","modified_gmt":"2024-09-23T08:07:38","slug":"grundlagen-der-technischen-dokumentation-fuer-einsteiger","status":"publish","type":"post","link":"https:\/\/lexsys.de\/de\/grundlagen-der-technischen-dokumentation-fuer-einsteiger\/","title":{"rendered":"Grundlagen der Technischen Dokumentation f\u00fcr Einsteiger"},"content":{"rendered":"\n<p><br>Unternehmen und Start-ups, die sich zum ersten Mal mit dem Thema&nbsp;<strong>Technische Dokumentation<\/strong>&nbsp;besch\u00e4ftigen, k\u00f6nnen sich schnell \u00fcberfordert f\u00fchlen, und haben wahrscheinlich viele Fragen:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Was genau ist Technische Dokumentation eigentlich?<\/li>\n\n\n\n<li>Warum unterscheidet man zwischen interner und externer Dokumentation?<\/li>\n\n\n\n<li>Warum muss ich an verschiedene Zielgruppen denken?<\/li>\n\n\n\n<li>Was f\u00fcr rechtliche Anforderungen und Normen sind zu beachten?<\/li>\n\n\n\n<li>Was macht eigentlich ein technischer Redakteur?<\/li>\n\n\n\n<li>Welche Tools ben\u00f6tige ich?<\/li>\n\n\n\n<li>Und wie kann ich meine Technische Dokumentation \u00fcbersetzen lassen?<\/li>\n<\/ul>\n\n\n\n<p>Fragen \u00fcber Fragen, die wir in diesem Artikel leicht verst\u00e4ndlich f\u00fcr Sie beantworten. Mit diesem Grundwissen sind Sie f\u00fcr die n\u00e4chsten Schritte gewappnet.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Was ist technische Dokumentation?<\/strong><\/h2>\n\n\n\n<p><a href=\"https:\/\/de.wikipedia.org\/wiki\/Technische_Dokumentation\" target=\"_blank\" rel=\"noopener\">Technische Dokumentation<\/a>&nbsp;(TD), auch&nbsp;<em>Produktdokumentation<\/em>&nbsp;genannt, bezeichnet alle Unterlagen zu technischen Ger\u00e4ten und Softwareprodukten. Diese Unterlagen, egal ob in Papierform oder im Onlineformat, beschreiben deren sichere Nutzung, Wartung oder Reparatur.<\/p>\n\n\n\n<p>Technische Dokumentation ist immer zweckorientiert: Sie soll die jeweilige Zielgruppe, beispielsweise Bediener, Techniker oder Vertriebsingenieure, zum Handeln bef\u00e4higen. Au\u00dferdem sichert sich der Hersteller haftungsrechtlich ab \u2013 und erf\u00fcllt mit der Produktdokumentation gleichzeitig alle gesetzlichen Anforderungen und Nachweispflichten.<\/p>\n\n\n\n<p>Im Allgemeinen unterscheidet man zwischen interner und externer Technischer Dokumentation:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Die\u00a0<strong>interne Technische Dokumentation<\/strong>\u00a0dient zur Archivierung aller produktrelevanten Unterlagen und verbleibt meist beim Hersteller, der sie bewahrt und aktualisiert. Dazu geh\u00f6ren u.\u00a0a. Pflichtenhefte, Versuchsberichte, Risikobeurteilungen und technische Zeichnungen.<\/li>\n\n\n\n<li>Mit der\u00a0<strong>externen Technischen Dokumentation<\/strong>\u00a0werden Betreiber und Benutzer des Produkts informiert und angeleitet, beispielsweise \u00fcber Montage-, Installations-, Benutzer- und Wartungsanleitungen.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>An welche Zielgruppe richtet sich die technische Dokumentation?&nbsp;<\/strong><\/h2>\n\n\n\n<p>\u201eWer ist meine Zielgruppe?\u201c lautet die wichtigste Frage, die Hersteller vor der Erstellung der Technischen Dokumentation beantworten m\u00fcssen. Idealerweise sollte f\u00fcr jede Zielgruppe ein eigenes Dokument erstellt werden, statt einer 400-seitigen Megaanleitung f\u00fcr alle.<\/p>\n\n\n\n<p>\u00dcberlegen Sie vorab, welche Handlungen \u00fcber den gesamten Lebenszyklus des Ger\u00e4ts erforderlich sind und wer daf\u00fcr zust\u00e4ndig ist. Tragen Sie alle Informationen in einer kurzen \u00dcbersicht zusammen. Listen Sie dabei f\u00fcr jede notwendige Handlung die zust\u00e4ndige Person auf. Wie das aussieht, haben wir hier am Beispiel einer CNC-Drehmaschine beschrieben:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Planung: Herstellernahe Personen<\/li>\n\n\n\n<li>Transport: Transporteur<\/li>\n\n\n\n<li>Installation: Herstellernahe Personen<\/li>\n\n\n\n<li>Programmierung: CNC-Zerspaner, Programmierer<\/li>\n\n\n\n<li>Benutzung: CNC-Zerspaner<\/li>\n\n\n\n<li>Instandhaltung: CNC-Zerspaner<\/li>\n\n\n\n<li>Reparatur: CNC-Zerspaner, Servicetechniker<\/li>\n\n\n\n<li>Demontage\u2026<\/li>\n<\/ul>\n\n\n\n<p>In diesem Fall, den Dietrich Juhl in seinem Buch \u201eTechnische Dokumentation\u201c<sup>*1<\/sup>&nbsp;beschreibt, ben\u00f6tigt der CNC-Zerspaner keine Informationen zum Transport und zur Installation der Maschine. Was f\u00fcr ihn jedoch relevant ist, sind Anweisungen zur Programmierung, Benutzung und Instandhaltung.<\/p>\n\n\n\n<p>Demnach ergeben sich laut Juhl f\u00fcr die CNC-Maschine acht Anleitungen f\u00fcr die unterschiedlichen Zielgruppen ergeben:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Planungsunterlage<\/li>\n\n\n\n<li>Transportanleitung<\/li>\n\n\n\n<li>Installations- und Inbetriebnahmeanleitung<\/li>\n\n\n\n<li>Betriebsanleitung<\/li>\n\n\n\n<li>Programmierhandbuch<\/li>\n\n\n\n<li>drei Serviceunterlagen (jeweils eine f\u00fcr Mechanik, Hydraulik und Elektrik)<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Welche Normen und rechtliche Anforderungen m\u00fcssen Sie beachten?<\/strong><\/h2>\n\n\n\n<p>Die Sicherheit liegt dem Gesetzgeber am Herzen. Zum einen m\u00fcssen Produkte sicher konstruiert sein und d\u00fcrfen keine Gefahr f\u00fcr Personen darstellen. Wenn sich Risiken zum anderen nicht ausschlie\u00dfen lassen, m\u00fcssen Hersteller Hinweise und Warnungen f\u00fcr eine sichere Nutzung geben.<\/p>\n\n\n\n<p>Aus diesem Grund unterliegt die Technische Dokumentation einer gro\u00dfen Bandbreite an Normen und rechtlichen Anforderungen, die wir nachfolgend ausgew\u00e4hlt vorstellen:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Die<strong>\u00a0DIN EN 82079-1<\/strong>\u00a0ist eine Norm f\u00fcr die Erstellung von Gebrauchsanweisungen, die u.\u00a0a. die Qualit\u00e4t der Kommunikation, die Risikominimierung sowie den Inhalt und die Gestaltung von Gebrauchsanweisungen beschreibt. Kostenlose Checklisten helfen bei der Einhaltung. Diese Norm geh\u00f6rt zur Grundausstattung jedes technischen Redakteurs.<\/li>\n\n\n\n<li>Die\u00a0<strong>Maschinenrichtline 2006\/42\/EG<\/strong>\u00a0verpflichtet Hersteller zur Bereitstellung einer Betriebsanleitung in Herstellersprache und ggf. als \u00dcbersetzung, die den Wissensstand und die Verst\u00e4ndnisf\u00e4higkeit der Benutzer ber\u00fccksichtigt.<\/li>\n\n\n\n<li>Die\u00a0<strong>VDI-Richtlinie 4500<\/strong>\u00a0regelt verschiedene Aspekte der Technischen Dokumentation, von den Begriffen \u00fcber die Organisation und Verwaltung bis zur Planung, Gestaltung und Erstellung der Unterlagen.<\/li>\n\n\n\n<li>Die Norm\u00a0<strong>DIN EN ISO 7010<\/strong>\u00a0regelt einen einheitlichen Standard f\u00fcr die Sicherheitskennzeichnung weg von Textschildern hin zu sprachunabh\u00e4ngigen und universell verst\u00e4ndlichen Sicherheitskennzeichnungen.<\/li>\n\n\n\n<li>Die\u00a0<strong>ANSI Z535<\/strong>\u00a0ist die US-amerikanische Norm f\u00fcr Sicherheitshinweise. Sie ist nicht f\u00fcr Produkte relevant, die in Europa auf den Markt gebracht werden, aber f\u00fcr Hersteller interessant, die ihre Ger\u00e4te und Maschinen in die USA exportieren.<\/li>\n\n\n\n<li>Das\u00a0<strong>Produktsicherheitsgesetz<\/strong>\u00a0(ProdSG) ist die Umsetzung der EU-Richtlinie 2001\/95\/EG und damit das wichtigste Regelwerk in Deutschland f\u00fcr die Bereitstellung von Produkten.<\/li>\n<\/ul>\n\n\n\n<p>Daneben gelten weitere Richtlinien f\u00fcr verschiedene Produktgruppen, wie das&nbsp;<strong>Medizinproduktegesetz&nbsp;<\/strong>(MPG) oder die&nbsp;<strong>Niederspannungsrichtlinie<\/strong>&nbsp;(2006\/95\/EG). Zudem gelten f\u00fcr verschiedene Regionen, wie f\u00fcr die EU und die USA unterschiedliche Anforderungen.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Welche Rolle spielt der technische Redakteur?<\/strong><\/h2>\n\n\n\n<p>Die Erstellung der Technischen Dokumentation geh\u00f6rt nicht zum Aufgabenbereich des Ingenieurs, wie manche vielleicht vermuten, sondern ist Sache des&nbsp;<strong>Technischen Redakteurs<\/strong>&nbsp;(TR). Er ben\u00f6tigt die F\u00e4higkeit, komplexe Sachverhalte und Funktionen einfach und f\u00fcr die jeweilige Zielgruppe zu erkl\u00e4ren und steht h\u00e4ufig im direkten Austausch mit dem Entwicklungsteam des Herstellers.<\/p>\n\n\n\n<p>Technische Dokumentationen sind jedoch keine Marketingbrosch\u00fcren oder Werbetexte \u2013 sondern unterschiedliche Disziplinen. F\u00fcr die Erstellung von verkaufsf\u00f6rdernden Produkttexten, Hochglanzbrosch\u00fcren und Flyern sind weitere Fertigkeiten gefragt.<\/p>\n\n\n\n<p>Technische Redakteure, die auch im Copywriting versiert sind, k\u00f6nnen beide Aufgabenbereiche \u00fcbernehmen. Wenn das nicht der Fall ist, sollten Technische Redakteure und Copywriter gemeinsam an einem Projekt arbeiten:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Der\u00a0<strong>Technische Redakteur<\/strong>\u00a0stellt sicher, dass alle technischen Fakten korrekt sind und<\/li>\n\n\n\n<li>der\u00a0<strong>Copywriter<\/strong>\u00a0schreibt verkaufsstarke und attraktive Texte. \u00a0<\/li>\n<\/ul>\n\n\n\n<p>Weitere Vorteile der Zusammenarbeit zwischen dem Technischen Redakteur und Textern finden Sie in unserem Artikel&nbsp;<a href=\"https:\/\/lexsys.de\/de\/blog\/technischer-redakteur-marketing-mix\">Der Technische Redakteur im Marketing-Mix<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Welche Software und Tools ben\u00f6tigen Sie f\u00fcr Ihre technische Dokumentation?<\/strong><\/h2>\n\n\n\n<p>Die Verwaltung Ihrer Technischen Dokumentation kann eine Herausforderung sein. Hersteller m\u00fcssen jede Funktions\u00e4nderung genau dokumentieren und sicherstellen, dass diese \u00c4nderungen in allen externen Unterlagen aktualisiert werden. Wir bei Lexsys raten daher von der Verwaltung Ihrer Technischen Dokumentation in Microsoft Word oder anderen Textverarbeitungsprogrammen ab.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Wie gut eignen sich Component-Content-Management-Systeme f\u00fcr die Technische Dokumentation?<\/strong><\/h2>\n\n\n\n<p>In den vergangenen Jahren haben Content-Management-Systeme (CMS) an Popularit\u00e4t gewonnen, da sie das Erstellen, Pflegen und Ver\u00f6ffentlichen von TD erleichtern. Noch interessanter f\u00fcr Hersteller sind jedoch&nbsp;<strong>Component-Content-Management-Systeme (CCMS)<\/strong>, die nicht ganze Dokumente, sondern Informationsbausteine abspeichern.<\/p>\n\n\n\n<p>Das kann zum Beispiel eine Abbildung, eine Tabelle, eine Produktbeschreibung oder ein Prozess sein. Ein Informationsbaustein kann dabei so kurz sein wie ein einzelnes Wort oder so umfangreich wie ein ganzes Dokument.<\/p>\n\n\n\n<p>Die Grundlage solcher Component-Content-Management-Systeme sind verschiedene Dokumentformate wie&nbsp;<a href=\"https:\/\/de.wikipedia.org\/wiki\/Darwin_Information_Typing_Architecture\" target=\"_blank\" rel=\"noopener\">DITA<\/a>, eine XML-basierte Architektur f\u00fcr die Erstellung, Verteilung und Wiederverwendung von technischen Informationen.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Wie \u00fcbersetze ich eine technische Dokumentation?<\/strong><\/h2>\n\n\n\n<p>Unternehmen, die ihre Produkte auch im Ausland vertreiben wollen, ben\u00f6tigen eine \u00dcbersetzung ihrer technischen Kommunikation f\u00fcr das jeweilige Zielland. Laut der&nbsp;<a href=\"https:\/\/www.tekom.de\/technische-kommunikation-das-berufsfeld\/kompetenzrahmen-fuer-die-technische-uebersetzung\" target=\"_blank\" rel=\"noopener\">tekom<\/a>, der Gesellschaft f\u00fcr Technische Kommunikation, werden fast die H\u00e4lfte aller technischen Dokumentationen in mehr als zehn Sprachen \u00fcbersetzt.<\/p>\n\n\n\n<p>Da nur noch sehr wenige Hersteller firmeneigene \u00dcbersetzer und Lokalisierungsteams besch\u00e4ftigen, beauftragen viele Unternehmen externe \u00dcbersetzungsagenturen. Das bringt f\u00fcr Hersteller viele Vorteile mit sich, denn Agenturen&nbsp;\u2026<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\u00fcbernehmen das gesamte Projektmanagement,<\/li>\n\n\n\n<li>arbeiten mit einem Pool an hoch qualifizierten Fach\u00fcbersetzern zusammen,<\/li>\n\n\n\n<li>bieten dank ISO-Zertifizierung eine hervorragende Qualit\u00e4tssicherung und<\/li>\n\n\n\n<li>bringen branchenspezifisches Know-how mit.<\/li>\n<\/ul>\n\n\n\n<p>Eine professionelle \u00dcbersetzungsagentur kann Hersteller zu allen Fragen der&nbsp;<a href=\"https:\/\/lexsys.de\/de\/blog\/tipps-fuer-die-erstellung-und-uebersetzung-von-technischer-dokumentation\">\u00dcbersetzung von Technischer Dokumentation<\/a>&nbsp;bis hin zu den Vor- und Nachteilen der&nbsp;<a href=\"https:\/\/lexsys.de\/de\/blog\/maschinelle-uebersetzung\">maschinellen \u00dcbersetzung<\/a>&nbsp;und dem&nbsp;<a href=\"https:\/\/lexsys.de\/de\/blog\/machine-translation-post-editing\">Maschine Translation Post-Editing<\/a>, der manuellen Pr\u00fcfung maschinell \u00fcbersetzter Texte durch Profis, beraten.<\/p>\n\n\n\n<p>Da der \u00dcbersetzungsmarkt unreguliert und un\u00fcbersichtlich ist, sollten Hersteller verschiedene Anbieter gr\u00fcndlich pr\u00fcfen, bevor Sie sich f\u00fcr die Zusammenarbeit mit einem&nbsp;<strong>vertrauensw\u00fcrdigen \u00dcbersetzungsdienstleister<\/strong>&nbsp;entscheiden.<\/p>\n\n\n\n<p>Diese zeichnen sich beispielsweise durch folgende Qualit\u00e4tskriterien aus \u2026<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>eine Zertifizierung nach ISO 9001,<\/li>\n\n\n\n<li>positives Kundenfeedback,<\/li>\n\n\n\n<li>transparente Prozesse und Preise und<\/li>\n\n\n\n<li>eine Zusammenarbeit mit muttersprachlichen und professionellen \u00dcbersetzern.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Wo finden Sie n\u00fctzliche Ressourcen?<\/strong><\/h2>\n\n\n\n<p>M\u00f6chten Sie noch mehr zum Thema Technische Dokumentation erfahren? Hier finden Sie weitere n\u00fctzliche Informationen:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/www.vdi.de\/richtlinien\" target=\"_blank\" rel=\"noopener\">VDI-Richtlinien<\/a>: Hier k\u00f6nnen Sie Publikationen der verschiedenen Richtlinien erwerben.<\/li>\n\n\n\n<li><a href=\"https:\/\/www.tekom.de\/\" target=\"_blank\" rel=\"noopener\">tekom<\/a>: auf der Website des weltweit gr\u00f6\u00dften Fach- und Berufsverbands f\u00fcr Technische Informationen finden Sie Infos auf Deutsch zu Fachkongressen, Branchenevents, Weiterbildungsm\u00f6glichkeiten und vieles mehr.<\/li>\n\n\n\n<li><sup>1<\/sup>\u201e<strong>Technische Dokumentation: Praktische Anleitungen und Beispiele<\/strong>\u201c von Dietrich Juhl, Springer Vieweg, 2015. Dieser Ratgeber richtet sich vor allem an technische Redakteure und liefert viele n\u00fctzliche Tipps zur Erstellung verschiedener Anleitungen.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Lexsys: Ihr zuverl\u00e4ssiger Partner f\u00fcr Technische Dokumentation&nbsp;<\/strong><\/h2>\n\n\n\n<p>Die Welt der Technischen Dokumentation kann f\u00fcr Hersteller von Ger\u00e4ten und Software \u00fcberw\u00e4ltigend sein. Sie m\u00fcssen&nbsp;\u2026<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>rechtliche Anforderungen und Normen einhalten,<\/li>\n\n\n\n<li>\u00fcber ihre Zielgruppe nachdenken,<\/li>\n\n\n\n<li>einen technischen Redakteur mit der Erstellung der Inhalte beauftragen,<\/li>\n\n\n\n<li>den Content anschlie\u00dfend auch pflegen, verwalten und publizieren und<\/li>\n\n\n\n<li>eventuell sogar noch \u00fcbersetzen.<\/li>\n<\/ul>\n\n\n\n<p>Kein leichtes Unterfangen. Wir bei Lexsys begleiten Hersteller bereits seit vielen Jahren auf diesem Weg und beraten Sie gern in allen Angelegenheiten der Technischen Kommunikation \u2013 von den&nbsp;<a href=\"t3:\/\/page?uid=215\">Kosten<\/a>&nbsp;\u00fcber die Software bis zur Erstellung und \u00dcbersetzung Ihrer Dokumentation.<\/p>\n\n\n\n<p>Ben\u00f6tigen Sie Unterst\u00fctzung bei Ihrer technischen Dokumentation?&nbsp;<a href=\"https:\/\/lexsys.de\/de\/kontakt\">Kontaktieren Sie uns<\/a>&nbsp;noch heute und vereinbaren Sie ein Beratungsgespr\u00e4ch.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Der Einstieg in die Technische Dokumentation kann f\u00fcr Start-ups und Unternehmen \u00fcberw\u00e4ltigend sein. Hier finden Sie die wichtigsten Grundlagen.<\/p>\n","protected":false},"author":5,"featured_media":1018,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[14],"class_list":["post-1017","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-information-design","tag-technische-dokumentation"],"_links":{"self":[{"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/posts\/1017","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/comments?post=1017"}],"version-history":[{"count":1,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/posts\/1017\/revisions"}],"predecessor-version":[{"id":1019,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/posts\/1017\/revisions\/1019"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/media\/1018"}],"wp:attachment":[{"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/media?parent=1017"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/categories?post=1017"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lexsys.de\/de\/wp-json\/wp\/v2\/tags?post=1017"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}