technische-dokumentation.org

Technische Dokumentation org buendelt Grundlagenwissen zu Normen, Standards, Methoden und Fachorganisationen rund um das professionelle Erstellen technischer Informationen.

Im Mittelpunkt steht eine strukturierte Orientierung zu Anforderungen, die beim Erstellen von Nutzungsinformationen, Betriebsanleitungen und weiteren Dokumentationsarten eine Rolle spielen. Dazu werden zentrale Normen und Regelwerke eingeordnet, darunter Vorgaben aus EU Richtlinien und EU Verordnungen wie Maschinenrichtlinie, Maschinenverordnung und Medizinprodukteverordnung sowie internationale und nationale Standards. Erlaeutert werden unter anderem DIN EN IEC IEEE 82079 1 als branchenuebergreifende Grundlage fuer Gebrauchsanleitungen, DIN EN ISO 12100 im Kontext von Risikobeurteilung und Risikominderung, ANSI Z535 6 fuer Sicherheits und Warnhinweise, die Normenreihe ISO IEC IEEE 26511 bis 26515 fuer Softwaredokumentation inklusive agiler Umgebungen, sowie DIN EN ISO 17100 fuer Prozesse und Qualitaetsanforderungen bei Uebersetzungen technischer Inhalte. Auch Standards fuer strukturierte und digitale Informationsbereitstellung wie iiRDS und die VDI Richtlinie 2770 werden thematisiert, jeweils mit dem Blick darauf, wie Informationen klassifiziert, ausgetauscht und nutzbar gemacht werden koennen.

Ergaenzend werden bewaehrte Methoden und Konzepte vorgestellt, die in der Praxis der Technischen Redaktion und Technischen Kommunikation zur Planung, Strukturierung und Darstellung von Inhalten eingesetzt werden. Dazu zaehlen Minimal Manual und Minimalismus, Information Mapping, Funktionsdesign und Klassenkonzepttechnik sowie strukturierte Dokumentationsansaetze wie DocBook, S1000D und DITA. Ebenfalls enthalten sind PI Mod und PI Klassifikation zur Modellierung und Klassifikation modularer Inhalte, Diataxis zur Trennung von Tutorials, How to Guides, Referenzen und Erklaerungen sowie Rich Documentation Design als Ansatz zur Kombination aus hohem Nutzwert und bewusst reduziertem Umfang. Als zusaetzlicher Baustein werden frei verfuegbare Styleguides und Redaktionsleitfaeden aufgegriffen, etwa die tekom Leitlinie Regelbasiertes Schreiben und ASD STE 100 Simplified Technical English fuer kontrollierte Sprache in englischsprachiger Dokumentation.

Das Angebot richtet sich an Personen, die Technische Dokumentation erstellen, beauftragen oder verantworten, zum Beispiel in Maschinenbau, Anlagenbau, Prozessindustrie, Softwareentwicklung oder im Umfeld regulierter Produkte. Typische Einsatzsituationen sind die Planung einer Dokumentationsstrategie, die Auswahl passender Standards, das Ableiten von Anforderungen fuer Struktur und Informationsqualitaet, der Umgang mit Sicherheitsinformationen und Warnhinweisen sowie die Organisation modularer Inhalte fuer unterschiedliche Zielgruppen und Ausgabekanaele. Neben Normen und Methoden werden auch einschlaegige Organisationen und Berufsverbaende wie tekom, STC, ISTC und BDUe sowie wichtige Tagungen, Konferenzen und Fachmessen im Bereich Technische Dokumentation genannt, um die Einordnung in die Fachcommunity zu unterstuetzen. Verantwortet wird die Zusammenstellung als Information von indoition, Ingenieurbuero fuer Technische Kommunikation, Marc Achtelig. Domain: https://technische-dokumentation.org