Top 10 Normen und Richtlinien zum Erstellen einer Technischen Dokumentation

Gut zu wissen: Normen spiegeln den Stand der Technik wider, sind jedoch keine Gesetze. Daher müssen Normen im Allgemeinen nicht zwingend angewandt werden – es sei denn, dies wird von einem Gesetz oder von einer Verordnung ausdrücklich so gefordert.

Alleine durch das Einhalten bestimmter Normen wird eine Technische Dokumentation daher auch nicht automatisch „rechtssicher“ oder „rechtskonform“, wie manche Versprechen Glauben machen. Allerdings ist es im Haftungsfall durchaus vorteilhaft, nachweisen zu können, dass die relevanten Normen berücksichtigt wurden. Denn damit ist allgemein davon auszugehen, dass die Dokumentation dem Stand der Technik entspricht (zumindest dem Stand der Technik zum Zeitpunkt des Entstehens der Norm) und dass beim Erstellen der Technischen Dokumentation mit der notwendigen Professionalität und Sorgfalt vorgegangen wurde. Ganz unabhängig von der rechtlichen Seite basieren die meisten Normen auf einem reichen Erfahrungsschatz und enthalten viel wertvolles Know-how, das sich nicht nur Konstrukteure, sondern auch Redakteure zu Nutzen machen sollten.

Anders als mit Normen verhält es sich mit EU-Richtlinien und EU-Verordnungen: EU-Richtlinien müssen von den Mitgliedsstaaten in eigene Gesetze umgesetzt werden und erhalten damit dann auch eine rechtliche Bindung. So finden sich in Deutschland beispielsweise die Anforderungen aus der EU-Maschinenrichtlinie im Produktsicherheitsgesetz wieder. Im Gegensatz zu EU-Richtlinien besitzen EU-Verordnungen sogar unmittelbar Gesetzeswirkung und müssen nicht mehr von den einzelnen EU-Mitgliedsstaaten in nationales Recht umgesetzt werden. Dies gilt beispielsweise für die Maschinenverordnung. Auch diese ist damit bindend.

Die nachfolgend als Top 10 aufgeführten Normen und Richtlinien sind bei Weitem nicht alle Standards, die beim Erstellen einer Technischen Dokumentation möglicherweise zu berücksichtigen sind. Sie bilden jedoch den Kern, auf den es in der Praxis in den meisten Fällen maßgeblich ankommt.

Je nach zu dokumentierendem Produkt können darüber hinaus weitere, insbesondere produktspezifische Normen und Richtlinien relevant sein.

Maschinenrichtlinie, Maschinenverordnung, Medizinprodukteverordnung

Ist ein Produkt eine Maschine, ist hierfür die Maschinenrichtlinie 2006/42/EG zu beachten. Diese Richtlinie behandelt nicht nur die Anforderungen an die Konstruktion, sondern auch inhaltliche und formale Anforderungen an die Technische Dokumentation zur Maschine. Hierzu zählt insbesondere, welche Dokumente mitgeliefert werden müssen und was die Betriebsanleitung zu beinhalten hat. Entscheidend hierfür ist insbesondere das Ergebnis einer Risikoanalyse (siehe hierzu auch DIN EN ISO 12100).

Zudem enthält die Maschinenrichtlinie zahlreiche Regelungen für das Inverkehrbringen von Maschinen sowie Anforderungen an die Sicherheit und den Gesundheitsschutz. Der Hersteller einer Maschine muss sicherstellen, dass Risiken minimiert sind und unvermeidbare Restrisiken in der Betriebsanleitung genannt sind und mit adäquaten Warnhinweisen darauf hingewiesen wird. Für eine unvollständige Maschine gilt Analoges für die Montageanleitung.

Auch für die Konformitätserklärung (CE-Kennzeichnung) ist das Erstellen einer Technischen Dokumentation Voraussetzung.

Für ab dem 20.01.2027 in Verkehr gebrachte Maschinen ersetzt die Maschinenverordnung (EU) 2023/1230 die Maschinenrichtlinie 2006/42/EG.

Für Medizinprodukte gilt analog die Medizinprodukteverordnung (MDR = Medical Device Regulation). Als EU-Verordnung besitzt sie ähnlich der Maschinenverordnung unmittelbare Gesetzeswirkung. Hinsichtlich der Technischen Dokumentation enthält die Verordnung eine Reihe spezifischer Regeln, unter anderem hinsichtlich Inhalten, Struktur und Aktualität.

DIN EN ISO 12100

„Sicherheit von Maschinen – Allgemeine Gestaltungsleitsätze – Risikobeurteilung und Risikominderung“

Die Norm DIN EN ISO 12100 beschäftigt sich speziell mit der Risikobeurteilung von Maschinen, wie sie von der Maschinenverordnung und Maschinenrichtlinie gefordert wird. Damit dient sie als Leitfaden, um sicherzustellen, dass Produkte den erforderlichen Sicherheitsstandards entsprechen und eventuelle Restrisiken minimiert sind.

Die Norm DIN EN ISO 12100 betrifft damit in erster Linie die Konstruktion und nicht direkt die Technische Dokumentation. Allerdings ist ein wichtiges Ergebnis der Risikoanalyse die genaue Auflistung der notwendigen Warnhinweise mit entsprechenden Signalwörtern. Diese Aufstellung dient wiederum als Vorgabe für die Technische Dokumentation.

DIN EN IEC/IEEE 82079-1

„Erstellung von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen“

Die Norm DIN EN IEC/IEEE 82079-1 ist die wichtigste allgemeine, branchenunabhängige Norm zum Erstellen einer Technischen Dokumentation. Die Norm beschreibt, was beim Erstellen von Gebrauchsanleitungen zu beachten ist: vom Strukturieren der Informationen bis hin zum Aufbereiten und Darstellen der Inhalte.

Die Norm hat einen horizontalen Charakter, was bedeutet, dass parallel zu ihr auch sektor- oder produktspezifische Normen angewendet werden können und sollen.

Insbesondere behandelt die Norm DIN EN IEC/IEEE 82079-1 folgende Themen:

• Begriffe
• Anforderungen an Nutzungsinformationen
• Grundsätze (Informationstypisierung, Zielgruppenorientierung, sichere Nutzung des beschriebenen Produkts, Anforderungen an die Informationsqualität hinsichtlich Vollständigkeit, Minimalismus, Korrektheit, Prägnanz, Konsistenz, Verständlichkeit, Barrierefreiheit, reproduzierbarer Lebenszyklus der Informationsprodukte)
• Informationsmanagement-Prozess
• Inhalt von Nutzungsinformationen
• Struktur, sowohl im Groben (Kapitelstruktur) als auch im Detail (z. B. Struktur von Schritt-für-Schritt-Anleitungen)
• Medien und Darstellung von Nutzungsinformationen, Nutzerinteraktion und Suchfunktionen, Downloadbarkeit, Lesbarkeit etc.
• Berufliche Kompetenzen der am Erstellen der Technischen Dokumentation beteiligten Personen

Damit fasst die Norm im Wesentlichen das zusammen, was ein professioneller Technischer Redakteur in seiner Ausbildung lernt. Rezeptähnliche Checklisten oder Anweisungen bietet die Norm allerdings nicht, sondern legt primär nur die Rahmenbedingungen und Prinzipien fest, nach denen die Dokumentation erstellt und aufgebaut werden soll. Damit lässt die Norm Experten einen gewissen Freiraum für ein produktspezifisches Ausgestalten der Technischen Dokumentation.

ANSI Z535.6

„American National Standard for Product Safety Information in Product Manuals, Instructions, and Other Collateral Materials“

Das American National Standards Institute (ANSI) ist das amerikanische Pendant zum Deutschen Institut für Normung (DIN). Die Norm ANSI Z535.6 befasst sich detailliert mit dem Gestalten von Sicherheits- und Warnhinweisen in Dokumenten. Da sich in den deutschen und europäischen Normen hierzu nur wenige konkrete Angaben finden, dient die ANSI Z535.6 auch in Europa für Sicherheits- und Warnhinweise als wichtiger Maßstab.

Die ANSI Z535.6 kategorisiert die Sicherheitshinweise in Bezug auf deren Position und Funktion im Dokument und legt Darstellungsformen für die einzelnen Kategorien an Sicherheitshinweisen fest.

Insbesondere regelt die Norm die Unterteilung von Warnhinweisen in die bekannten Kategorien „Gefahr“, „Warnung“, „Vorsicht“ und „Achtung“ und legt fest, was diese Warnhinweise jeweils beinhalten sollen: Signalwort, die Art der Gefahr, mögliche Folgen sowie Maßnahmen zum Vermeiden der Gefahr. Übrigens fordert die Norm ANSI Z535.6 nicht die häufig anzutreffende, übertrieben auffällige Gestaltung von Warnhinweisen, sondern eine Gestaltung, die den Lesefluss nicht zerstört und ein Dokument nicht vor lauter Warnhinweisen kaum noch lesbar macht.

Ziel ist es, eine stärkere Vereinheitlichung und höhere Qualität von Sicherheitsinformationen zu erreichen, damit die Benutzer der in der Technischen Dokumentation beschriebenen Produkte diese Informationen schnell erkennen und sicher verstehen können.

ISO/IEC/IEEE 26511 bis 26515

Die Normenreihe ISO/IEC/IEEE 26511 - 26515 behandelt speziell das Thema Softwaredokumentation im gesamten Lebenszyklus der Benutzerinformation: Von der Planung bis zum Test der Verständlichkeit – insbesondere auch in einer agilen Entwicklungsumgebung.

Im Hinblick auf Softwaredokumentation sind vor allem die Normen ISO/IEC/IEEE 26514 und ISO/IEC/IEEE 26515 interessant.

ISO/IEC/IEEE 26514

„Systems and software engineering – Design and development of information for users (System- und Software-Engineering – Design und Entwicklung von Informationen für Anwender)“

Diese Norm befasst sich schwerpunktmäßig mit dem Informationsbedarf der Endanwender. Sie definiert Anforderungen an Layout, Struktur und Inhalt und bietet dazu auch einige Checklisten. Dabei enthält die Norm auch viele Punkte, die eigentlich nicht spezifisch nur für Softwaredokumentation relevant sind, sondern sich auch auf Technische Dokumentation im Algemeinen anwenden lassen.

ISO/IEC/IEEE 26515

„Systems and software engineering – Developing user documentation in an agile environment (Software und System-Engineering – Entwickeln von Informationen für Benutzer in einer agilen Umgebung)“

Diese Norm richtet sich speziell an Personen, die in agilen Umgebungen arbeiten und enthält Vorgaben für Erstellen und Verwalten von Informationen innerhalb einer solchen agilen Entwicklungsumgebung.

DIN EN ISO 17100

„Übersetzungsdienstleistungen – Anforderungen an Übersetzungsdienstleistungen“

Wenn Ihre Technische Dokumente in Fremdsprachen übersetzt wird, liefert diese Norm Regeln hinsichtlich optimaler Arbeitsabläufe und Qualitätsanforderungen der Übersetzung.

Die Norm DIN EN ISO 17100 beschreibt in erster Linie wichtige Aspekte des Übersetzungsprozesses und von Übersetzungstechnologien und definiert die erforderliche Qualifikation der Übersetzer. Sie enthält jedoch wenig Angaben zur inhaltlichen Übersetzungsqualität. Hierzu liefert DIN ISO 5060 „Übersetzungsdienstleistungen – Evaluierung“ weitere Hinweise.

iiRDS

„Intelligent Information Request and Delivery Standard“

iiRDS ist ein Standard mit dem Ziel, „intelligente Informationen“ zu erstellen, austauschen und anzeigen zu können. Anders als bei klassischer Technischer Dokumentation (Handbücher) bestehen solche „intelligente Informationen“ aus modularen, mit Metadaten versehenen Informationsbausteinen. Je nach Situation und Kontext, in denen ein Benutzer diese Informationen benötigt, kann ein sogenanntes Content-Delivery-Portal diese Informationen „intelligent“ auf die Situation und den Nutzer bezogen zusammenstellen und anzeigen.

Da es sich um einen Standard handelt, können dabei auch Informationen aus unterschiedlichen Quellen zusammenfließen, unabhängig davon, wer diese Informationen erstellt hat und mit welchem Redaktionssystem sie erstellt wurden.

VDI-Richtlinie 2770

„Betrieb verfahrenstechnischer Anlagen – Mindestanforderungen an digitale Herstellerinformationen für die Prozessindustrie“

VDI-Richtlinie 2770 verfolgt ähnlich wie iiRDS einen standardisierten Austausch digitaler Informationen. Die VDI-Richtlinie 2770 legt ihr Augenmerk jedoch nicht auf kleine Informationsbausteine (Topics), sondern auf ganze Dokumente (PDF-Dateien).

Ziel ist hier weniger der kontextabhängige Zugriff als das effiziente Zusammenführen umfangreicher Dokumentationen aus unterschiedlichen Quellen und das Erleichtern des Zugriffs auf diese Informationssammlungen. Dafür standardisiert die Richtlinie Klassifikation, Identifikation, Struktur und Format.

VDI-Richtlinie 2770 ist in erster Linie für den Anlagenbau, die Verfahrenstechnik und Prozessindustrie und deren Zulieferer relevant. Für die dort häufig sehr komplexen Gesamtsysteme verspricht die Richtlinie eine deutliche Verbesserung bei der Organisation der Dokumente.

tekom-Leitlinie „Regelbasiertes Schreiben

“

„Deutsch für Technische Kommunikation“

Wer im Detail konkrete Fragen zur Texterstellung hat, findet in der tekom-Leitlinie „Regelbasiertes Schreiben“ oft konkretere Antworten als in der allgemeinen Norm IEC/IEEE 82079.1.

Die tekom-Leitlinie „Regelbasiertes Schreiben“ bietet klare Richtlinien und Empfehlungen für das Verfassen Technischer Dokumentationen. Die Leitlinie betont die Bedeutung von klaren, präzisen und leicht verständlichen Informationen. Sie legt Wert darauf, dass technische Texte durchgehend und konsistent formuliert werden, um Verwirrung zu vermeiden und die Lesbarkeit zu verbessern. Die Leitlinie ermutigt außerdem zum Verwenden einer standardisierten Terminologie und zum Vermeiden von Fachjargon, um die Verständlichkeit zu verbessern.

Angefangen bei der Dokumentgliederung über Verständnishilfen, wie Querverweise und Indexeinträge bis hin zu Satzstruktur, Wortwahl und Kommasetzung finden Technische Redakteure in der Leitlinie viele Regeln, die ihnen die tägliche Arbeit erleichtern.

Wertvoll sind außerdem die vielen in der Leitlinie enthaltenen praxisnahen Beispiele.

Im Redaktionsalltag nutzen viele Technische Redakteure die tekom-Leitlinie als eine Art Redaktionsleitfaden oder als Basis für einen hauseigenen Redaktionsleitfaden.

ASD STE 100

„Simplified Technical English (STE)“

Ähnlich der tekom-Leitlinie „Regelbasiertes Schreiben“ gibt es für englischsprachige Technische Dokumentation den Standard ASDSTE100 „Simplified Technical English“. Ursprünglich wurde dieser Standard für die Dokumentation in der Luftfahrtindustrie und im militärischen Bereich genutzt, bietet aber auch als generelles Regelwerk viele wertvolle Ansätze für eine einfache Sprache.

Den Kern des Standards bilden eine Terminologieliste erlaubter Wörter sowie generelle Regeln für einen kontrollierten, einfachen Satzbau. Hier gibt es auch viele Parallelen zur tekom-Leitlinie „Regelbasiertes Schreiben“.

Bild: © Marc Achtelig

Nicht alle Produkte sind vollständig selbsterklärend. Eine verständliche Technische Dokumentation ist dann unerlässlich.

Top 10 Methoden zum Erstellen einer Technischen Dokumentation

Zum Erstellen einer hochwertigen, leicht verständlichen Technischen Dokumentation haben sich in den letzten Jahren und Jahrzehnten eine Reihe bestimmter Methoden etabliert. Auch viele der vorstehend genannten Normen und Richtlinien fußen letztlich auf diesen bewährten Methoden.

In der Fachliteratur, oder wenn Sie einen Dienstleister mit dem Erstellen Ihrer Technischen Dokumentation beauftragen, werden Ihnen die Namen dieser Methoden immer wieder begegnen.

Die Reihenfolge der nachfolgenden Aufstellung entspricht in etwa dem zeitlichen Aufkommen der Methoden. Die ältesten Methoden sind dabei zuerst genannt.

Hinweis: Teilweise sind die Namen der Methoden geschützte Warenzeichen und eingetragene Marken, was jedoch keinen Einfluss auf ihre allgemeine weite Verbreitung hat.

Minimal Manual

Minimal Manual oder Minimalismus ist eine Strategie zum Erstellen von Benutzerhandbüchern und Anleitungen, die darauf abzielt, die Informationen auf das Wesentliche zu reduzieren. Statt umfangreicher und detaillierter Dokumentationen werden nur die wichtigsten Schritte und Informationen bereitgestellt, um die Bedürfnisse der Benutzer zu erfüllen.

An die Stelle langer Fließtexte („Beschreibungen in Romanform“) treten knapp formulierte Tabellen, Auflistungen und Schritt-für-Schritt-Anleitungen.

Dies reduziert die Komplexität und erleichtert es den Benutzern, die benötigten Informationen schnell zu finden und zu verstehen. Damit fördert die Methode eine effiziente Kommunikation und trägt dazu bei, die Benutzererfahrung (User Experience) beim Lesen einer Technischen Dokumentation erheblich zu verbessern.

Information Mapping

Information Mapping ist eine Methode zum Strukturieren und Organisieren von Informationen in schriftlichen Dokumenten ganz allgemein und findet nicht nur in der Technischen Dokumentation Anwendung.

Die Grundidee hinter Information Mapping besteht darin, komplexe Informationen in klar definierte und leicht verständliche Informationseinheiten („Blöcke“) zu unterteilen. Zu jedem Block gehört eine klare Überschrift („Label“), die den Inhalt des Blocks auf einen Blick zusammenfasst. Jeder Block vermittelt eine eigenständige Idee oder ein eigenständiges Konzept.

Damit können Leser die Inhalte im Unterschied zu einem langen Fließtext auf der Suche nach bestimmten Informationen schnell überfliegen und punktuell lesen.

Durch die Blöcke mit ihrem jeweiligen Label entsteht aus einem ehemals unübersichtlichen Dokument („Textwüste“) letztlich eine übersichtliche „Informationslandkarte“.

Funktionsdesign

Allgemein ist Funktionsdesign eine Methode, die dazu dient, die Funktionen eines Systems, Produkts oder Prozesses zu definieren und zu gestalten. Das Hauptziel eines Funktionsdesigns besteht darin, die Anforderungen und Bedürfnisse der Benutzer oder Kunden zu verstehen und darauf basierend Funktionen zu entwickeln, die diese Bedürfnisse erfüllen.

Die im Bereich der Technischen Dokumentation als Funktionsdesign bekannte Methode fußt in der sogenannten Sprechakttheorie: Reden ist Handeln. Jede sprachliche Äußerung ist eine sprachliche Handlung, die sich in Funktion, Inhalt und weitere Teilakte unterteilen lässt. In der Praxis bedeutet das: Ein Technischer Redakteur schreibt nicht wie ein Romanschriftsteller „drauflos“, sondern überlegt sich zuerst die Funktion einer bestimmten Information. Abhängig von dieser Funktion setzt er bestimmte funktionale Elemente zur optimalen Darstellung der Information ein: beispielsweise eine nummerierte Liste für eine schrittweise Handlungsanleitung statt einer romanartigen Beschreibung.

Dadurch wird eine Technische Dokumentation besser lesbar und in sich einheitlich („konsistent“). Auch zwingt diese Methode den Redakteur bis zu einem gewissen Grad dazu, sich beim Schreiben Gedanken über den konkreten Sinn und Zweck einer Aussage zu machen und fördert auf diese Weise das Weglassen irrelevanter Dinge.

Klassenkonzepttechnik

Allgemein ist die Klassenkonzepttechnik eine Methode zum Strukturieren von Informationen. Sie ist ein Werkzeug zur Analyse und Organisation komplexer Informationssysteme, insbesondere in den Bereichen Softwareentwicklung und Datenmodellierung. Das Hauptziel der Klassenkonzepttechnik besteht darin, Informationssysteme in Klassen zu unterteilen, die ähnliche Eigenschaften oder Funktionen aufweisen.

Angewandt auf das Erstellen Technischer Dokumentationen lassen sich als Klassen sowohl Informationsklassen als auch Linkklassen definieren. Typische Informationsklassen sind im Minimalausbau mindestens die Klassen „Konzepte“, „Anleitungen“ und „Referenzen“. Analog zu den Informationsklassen gibt es entsprechende Linkklassen für Querverweise auf verwandte Informationen.

Dadurch, dass unterschiedliche Informationsklassen vorgesehen werden, wird erreicht, dass Nutzer im Dokument sehr gezielt auf bestimmte Informationen zugreifen können und diese auch isoliert verstehen. Ein Thema enthält dann nicht mehr ein Durcheinander „aller“ Informationen, sondern z. B. nur Grundlagen, nur eine schrittweise Anleitung oder nur technische Daten zum Nachschlagen. Auf diese Weise werden z. B. Anfänger nicht mit Informationen für Fortgeschrittene überfordert. An einer schnellen Lösung interessierte Benutzer werden nicht mit Details aufgehalten.

Ein bewusst kompakt gehaltenes Dokumentationskonzept definiert für jede zu erstellende Technische Dokumentation, welche Informationsklassen im jeweiligen Dokument vorkommen und wie die Informationsmodule („Topics“) entsprechend dieser Klassen zu bilden sind. Auf dieser Basis entsteht für die Redakteure ein kompakter Redaktionsleitfaden als Grundlage für eine konsistente Dokumentation.

DocBook

Der Dokumentationsstandard DocBook wurde entwickelt, um Technische Dokumentationen in einem strukturierten und standardisierten Format zu erstellen (XML).

Der Standard bietet eine sehr große Vielzahl möglicher Elemente und Attribute, um die spezifischen Elemente von Dokumenten wie Abschnitte, Überschriften, Listen, Tabellen, Abbildungen, Querverweise usw. zu definieren. Diese Strukturierung ermöglicht es Autoren, Inhalte konsistent zu gestalten und gleichzeitig die Flexibilität zu haben, sie an unterschiedliche Anforderungen anzupassen.

Wesentliche Vorteile einer strukturierten Dokumentationserstellung mit Strukturen wie DocBook sind:

Trennung zwischen Layout und Inhalt: Anstatt einen Text individuell zu formatieren, zeichnen Redakteure einen Text nur noch inhaltlich (semantisch) aus. Zum Beispiel legen sie fest, dass es sich bei einem bestimmten Absatz um einen Warnhinweis handelt, weisen diesem Absatz aber kein spezielles optisches Erscheinungsbild zu. Basierend auf dem Inhaltstyp kümmert sich ein Redaktionssystem automatisiert um die Formatierung.

Qualität: Bis zu einem gewissen Grad zwingt die Struktur die Redakteure zu einem einheitlichen Aufbau der Dokumente, sodass die gesamte Technische Dokumentation aus einem Guss erscheint, auch wenn an der Erstellung mehrere Personen beteiligt sind.

Herstellerunabhängigkeit: Das Format ist ein herstellerunabhängiger Standard, was die Redakteure nicht dauerhaft an den Einsatz eines bestimmten Redaktionssystems bindet.

S1000D

S1000D ist ein international anerkannter Dokumentationsstandard, der speziell für die Erstellung, Verwaltung und Veröffentlichung Technischer Dokumentationen in der Luft- und Raumfahrt sowie im militärischen Bereich entwickelt wurde.

Innerhalb der Bereiche Luftfahrt und Verteidigung bietet der Standard insbesondere deshalb große Vorteile, weil auf seiner Basis umfangreiche Dokumentationen aus vielen Einzeldokumenten mehrerer Hersteller nahtlos zusammengeführt werden können – auch als elektronische Dokumentation (sogenannte Interactive Electronic Technical Publication, kurz IETP).

Der Standard bietet eine strukturierte Methode, um technische Informationen zu organisieren und auszutauschen. Dazu definiert der Standard eine große Anzahl an Regeln und Richtlinien, einschließlich spezifischer XML-Tags für verschiedene Arten von Inhalten wie Text, Grafiken, Tabellen, Listen und mehr. Diese strukturierte Herangehensweise ermöglicht es, Informationen in einzelne, wiederverwendbare Module zu unterteilen, die flexibel kombiniert und neu angeordnet werden können, um unterschiedliche Dokumentationsanforderungen zu erfüllen.

Der Einsatz von S1000D erleichtert die Zusammenarbeit zwischen verschiedenen Organisationen und Lieferanten und trägt dazu bei, die Effizienz und Genauigkeit der Technischen Dokumentation zu verbessern.

Außerhalb der Bereiche Luftfahrt und Verteidigung findet der Standard aufgrund seiner Komplexität in der Praxis jedoch bislang nur wenig Verwendung.

DITA

DITA steht für „Darwin Information Typing Architecture“ und wurde als Dokumentationsstandard mit dem Ziel entwickelt, das Erstellen, Verwalten und Veröffentlichen technischer Inhalte zu erleichtern.

Der Grundgedanke ist im Prinzip ähnlich wie bei DocBook, jedoch ist DITA moderner, flexibler und auch speziell für Softwaredokumentation einsetzbar. DITA sorgt für eine modulare und wiederverwendbare Struktur von Inhalten, die es ermöglicht, umfangreiche Dokumentationen effizient zu erstellen und zu pflegen.

Auch zur Klassenkonzepttechnik weist DITA viele Parallelen auf. DITA definiert eine Reihe XML-basierter Tags oder Elemente, mit denen Autoren Dokumente in kleine, eigenständige Einheiten unterteilen, sogenannte „Topics“. Diese Topics können dann flexibel kombiniert und angeordnet werden, um daraus unterschiedliche Dokumente zu erstellen, die unterschiedliche Informationsbedürfnisse erfüllen (z. B. „Erste Schritte Handbuch“ und „Referenzhandbuch“).

Die Möglichkeit, Topics mehrfach zu verwenden, senkt nicht nur Erstellungs- und Übersetzungskosten, sondern verbessert auch die Konsistenz innerhalb der Dokumentation.

PI-Mod und PI-Klassifikation

PI-Mod ist ein Informationsmodell, das primär für den Maschinen- und Anlagenbau entwickelt wurde, aber auch für andere Branchen wie die Automatisierungs- und Elektrotechnik verwendet werden kann.

Die PI-Klassifikation ist eine Methode zum Klassifizieren modularer Inhalte in Content-Management-Systemen. Die Bezeichnung „PI“ leitet sich ab von der doppelten Sichtweise auf modulare Inhalte: Produkt und Information. So werden jedem Informationsmodul eine P- und eine I-Klassifikation eindeutig zugewiesen, wodurch sich die Module systematisch verwalten und verwenden lassen.

Diátaxis

Ähnlich wie die Klassenkonzepttechnik und DITA definiert auch Diátaxis klar voneinander abgegrenzte Informationstypen. Bei Diátaxis sind diese Informationstypen: Tutorials („learning-oriented experiences“),  How-to-Guides („goal-oriented directions“), References („information-oriented technical descriptions“) sowie Explanations („understanding-oriented discussions“).

Anders als DITA sieht Diátaxis nicht zwingend eine XML-Struktur vor.

Rich Documentation Design

Rich Documentation Design ist ein Konzept mit dem Ziel, den Nutzwert einer Technischen Dokumentation zu maximieren und den Umfang gleichzeitig zu minimieren.

Das Rich Dokumentation Design ersetzt nicht ältere Dokumentationsmethoden, sondern adaptiert und ergänzt diese Methoden auf die heutige Zeit. Dabei trägt das Rich Documentation Design insbesondere der Tatsache Rechnung, dass Nutzer heute in vielen Fällen im Umgang mit Technik und Software wesentlich kompetenter sind als zu der Zeit, aus der die meisten klassischen Dokumentationsmethoden stammen. Viele Nutzer brauchen daher nicht (mehr) an jeder Stelle eine detaillierte Beschreibung, vielmehr verstellt eine solche vollständige Dokumentation nicht selten sogar den Blick auf das Wesentliche.

Zentrale Methoden des Rich Dcumentation Designs sind die Impuls-Technik und die Minimal-Brainwork-Prinzipien.

Die Impuls-Technik zielt darauf ab, nur noch das vollständig zu beschreiben, wofür die Nutzer der Dokumentation tatsächlich eine vollständige Beschreibung brauchen. Für alles andere werden kleine, flexibel eingesetzte Informationsfragmente, sogenannte Impulse, verwendet. Ein Impuls liefert nur so viel Informationen, dass Nutzer auf dieser Basis eigenverantwortlich handeln können, ohne Nutzern zwanghaft jeden Schritt im Detail vorzuschreiben.

Die Minimal-Brainwork-Prinzipien zielen darauf ab, die notwendigen Informationen so einfach wie möglich darzustellen, um das Auffinden und sprachliche Verstehen zu erleichtern.

Bonus: Im Web frei verfügbare Styleguides (Redaktionsleitfäden)

Ergänzend zu den obengenannten Methoden sollten Sie sich beim Erstellen einer größeren Technischen Dokumentation zudem einen Redaktionsleitfaden erstellen – oder einen bereits existierenden Redaktionsleitfaden nutzen.

In englischer Sprache gibt es bereits einige hervorragende frei verfügbare und sehr durchdachte Styleguides im Netz. Beim Erstellen von Softwaredokumentation ist der Einsatz eines der folgenden Leitfäden nahezu schon Standard:

➝ Microsoft Writing Style Guide

➝ Apple Publications Style Guide

➝ Google Developer Documentation Style Guide

Eine Sammlung weiterer Styleguides und Ressourcen für das Erstellen Technischer Dokumentation finden Sie darüber hinaus auf meiner Website ➝ www.indoition.com.

Top 10 Organisationen im Bereich Technische Dokumentation

Berufsverbände und Branchenverbände im Bereich der Technischen Dokumentation bieten die Möglichkeit, sich weiterzubilden und zu vernetzen. Sie fördern Best Practices und Standards, die zur Verbesserung der Qualität der Informationsprodukte beitragen, geben Fachzeitschriften heraus und organisieren Fachtagungen und Weiterbildungsveranstaltungen.

Wenn Sie selbst eine Technische Dokumentation erstellen oder an der Erstellung einer Technischen Dokumentation beteiligt sind, könnten die folgenden Organisationen und deren Angebote für Sie interessant sein:

tekom

Die Gesellschaft für Technische Kommunikation (tekom) ist der in Deutschland und Europa führende Fachverband im Bereich Technische Kommunikation und Technische Dokumentation. Mit einem breiten Spektrum an Ressourcen, Schulungen, Veranstaltungen und Fachpublikationen spielt die tekom eine entscheidende Rolle bei der Unterstützung von Fachleuten in diesem Bereich.

Die Veranstaltungen bieten Fachleuten und Interessenten die Möglichkeit, sich mit Kollegen auszutauschen, Best Practices zu teilen, neue Trends kennenzulernen und sich über die neuesten Entwicklungen in der Branche zu informieren.

Außerdem veröffentlicht die tekom eine Reihe an Fachpublikationen, darunter Zeitschriften, Fachbücher und Leitfäden. Diese Publikationen behandeln eine Vielzahl an Themen im Bereich der Technischen Dokumentation und Technischen Kommunikation und helfen Fachleuten dabei, ihr Wissen zu erweitern und ihre Fähigkeiten zu verbessern.

Ergänzt wird das Angebot durch diverse Online-Ressourcen für Mitglieder und Nicht-Mitglieder.

➝ tekom

STC

Die Society for Technical Communication (STC) ist im Wesentlichen das amerikanische Pendant zur deutschen tekom. Die STC wurde jedoch bereits deutlich früher gegründet.

Mit Tausenden Mitgliedern auf der ganzen Welt verfolgt die STC ähnlich wie die tekom das Ziel, die Qualität der Technischen Kommunikation und Technischen Dokumentation zu verbessern und Fachleuten in diesem Bereich Ressourcen und Unterstützung für eine erfolgreiche Arbeit zur Verfügung zu stellen.

Auch die STC bietet eine breite Palette von Dienstleistungen und Angeboten für ihre Mitglieder an.

➝ STC

ISTC

Das Institute of Scientific and Technical Communicators (UK), kurz ISTC, ist wiederum das britische Pendant zur deutschen tekom und zur amerikanischen STC, allerdings kleiner.

Analog fördert auch die ISTC die berufliche Weiterentwicklung ihrer Mitglieder und bietet Möglichkeiten zur Weiterbildung, zum Erfahrungsaustausch und zur Vernetzung.

Mit dem „Communicator“ veröffentlicht die ISTC eine vierteljährlich erscheinende Fachzeitschrift zu aktuellen Themen aus Forschung und Praxis der Technischen Kommunikation.

Netzwerkmöglichkeiten umfassen regionale Treffen, Online-Communities und die jährliche TCUK-Konferenz.

➝ ISTC

BDÜ

Insbesondere in Europa muss eine Technische Dokumentation häufig in eine oder oft sogar mehrere Fremdsprachen übersetzt werden.

Daher ist auch der Bundesverband der Dolmetscher und Übersetzer (BDÜ) im Bereich der Technischen Dokumentation und Technischen Kommunikation recht aktiv.

➝ BDÜ

Organisationen in weiteren Ländern

Neben tekom, STC und ISTC bestehen in einigen Ländern zusätzlich noch diverse landeseigene Organisationen im Bereich Technische Dokumentation und Technische Kommunikation:

In der Schweiz die tecom Schweiz:
➝ tecom Schweiz

In Italien die COM&TEC:
➝ COM&TEC

In Finnland die Finnish Technical Communication Society (STVY):
➝ STVY

In Australien die Australian Society for Technical Communication (ASTC):
➝ ASTC

In Neuseeland die Technical Communicators Association of New Zealand (TechCommNZ):
➝ TechCommNZ

In Japan die Japanese Technical Communicators Association (JTCA):
➝ JTCA

Top 10 Tagungen, Konferenzen und Fachmessen im Bereich Technische Dokumentation

Viele der vorstehend genannten Organisationen veranstalten regelmäßig Fachtagungen. Teilweise sind die Tagungen auch mit einer Fachmesse kombiniert, auf der Tool-Hersteller und Dienstleister ihre Angebote präsentieren.

Mitglieder der jeweiligen Organisationen erhalten meist ermäßigten Eintritt, jedoch stehen diese Veranstaltungen generell allen Interessenten offen.

Bild: © Marc Achtelig

Messe zur tekom-Jahrestagung

tekom-Jahrestagung und tcworld conference

Die tekom-Jahrestagung ist die wohl bedeutendste Veranstaltung im Bereich der Technischen Dokumentation. Sie findet jährlich im Spätherbst in Stuttgart statt und bringt Fachleute, Referenten, Studierende und Aussteller aus der ganzen Welt zusammen.

Die Tagung bietet eine breite Palette an Themen, von der Redaktion, über Standards, Normung, Recht, Übersetzung, Terminologie bis hin zu Usability, UX und den neusten Trends. Das Programm umfasst insgesamt mehrere Hundert Fachvorträge, Workshops und Ausstellerpräsentationen.

Parallel zur Jahrestagung in deutscher Sprache findet die tcworld conference in englischer Sprache statt. Internationale Branchenexperten teilen ihr Fachwissen und Best Practices aus allen Bereichen der Technischen Kommunikation.

Auf der tekom-Messe präsentieren Aussteller aus der ganzen Welt ihre Produkte und Dienstleistungen.

Am Abend finden Standpartys und eine gemeinsame Abendveranstaltung statt.

➝ tekom-Jahrestagung

STC Technical Communication Summit

Der STC Technical Communication Summit ist die jährliche Veranstaltung der Society for Technical Communication (STC). Auch diese Fachtagung zieht Hunderte von Teilnehmern aus der ganzen Welt an, darunter Technische Redakteure, Designer, Entwickler und andere Fachexperten. Die Konferenz dient als Plattform für den Wissensaustausch, die Diskussion neuer Trends und Entwicklungen in der Branche der Technischen Dokumentation sowie zum Knüpfen von Kontakten.

Die Teilnehmer können aus einer Vielzahl von Vorträgen, Workshops und Diskussionsrunden wählen. Zu den Themen gehören zum Beispiel Technische Redaktion, Grafikdesign, Webentwicklung und Content-Management-Systeme.

Die Veranstaltung bietet den Teilnehmenden eine hervorragende Gelegenheit, sich über aktuelle Themen und die neuesten Trends der Kommunikationsbranche auszutauschen und ihr Fachwissen zu teilen.

Der STC Technical Communication Summit findet in der Regel im Frühjahr an wechselnden Orten in den USA statt.

➝ STC Technical Communication Summit

Technical Communication UK (TCUK)

Technical Communication UK (TCUK) ist die jährliche Konferenz des Institute of Scientific and Technical Communicators (ISTC).

Die Konferenz findet jedes Jahr im September in Großbritannien statt und richtet sich an alle, die an der Erstellung, Bearbeitung, Illustration, Bereitstellung und Veröffentlichung technischer Informationen beteiligt sind.

Die Veranstaltung umfasst eine Vielzahl von Aktivitäten, darunter Vorträge, Workshops, Seminare und von Branchenexperten geleitete Diskussionsrunden. Zu den behandelten Themen gehören Content-Erstellung, Informationsdesign, Technologien für Technische Kommunikation, Übersetzung und Lokalisierung, Barrierefreiheit und Usability.

Ein wichtiger Aspekt der TCUK-Konferenz ist die Möglichkeit für Teilnehmer, sich zu vernetzen und zu netzwerken. Dazu gibt es diverse Gelegenheiten für informelle Gespräche, Diskussionen und den Austausch von Ideen mit Kollegen und Experten aus der Branche.

➝ TCUK Conference

Write the Docs

Die von der gleichnamigen Online-Community organisierte Konferenz Write the Docs setzt neben der Technischen Dokumentation im Allgemeinen einen gewissen Schwerpunkt auch auf Softwaredokumentation.

Die Vorträge und Präsentationen behandeln ein breites Spektrum an Themen, darunter Best Practices für die Technische Redaktion, Werkzeuge und Technologien für die Dokumentation, Content-Strategien, Barrierefreiheit und vieles mehr.

Neben klassischen Vorträgen gibt es speziell auch viele interaktive Sessions. Sogenannte Lightning Talks sprechen in Form kurzer, prägnanter Präsentationen eine Vielzahl von Themen an und sind eine schnelle Möglichkeit für Fachleute, ihre Ideen und Erfahrungen zu teilen. Diskussionsrunden bieten eine informelle Umgebung, in der Teilnehmer Themen diskutieren und Meinungen austauschen können.

Eine wichtige Komponente von Write the Docs ist die Möglichkeit für Teilnehmer, sich zu vernetzen und neue Kontakte zu knüpfen. Dazu gibt es verschiedene Networking-Veranstaltungen wie Abendveranstaltungen, informelle Treffen und Speed-Networking-Sessions.

➝ Write the Docs Conference

Weitere Fachtagungen

Neben den bekannten, vorstehend genannten Veranstaltungen sind ebenfalls besonders erwähnenswert:

MadWorld, Technical Communication and Learning & Development Conference (kommerzieller Anbieter):
➝ MadWorld

LavaCon Conference on Content Strategy and Technical Communication Management:
➝ LavaCon

LocWorld, conference for localization professionals, networking, and industry innovation:
➝ LocWorld

MEGAComm, Israels jährliche Tech Communicator Conference:
➝ MEGAComm

ASTC Conference, die Jahreskonferenz der Australian Society for Technical Communication:
➝ ASTC Cenference

TechCommNZ Conference der Technical Communicators Association of New Zealand:
➝ TechCommNZ Conference