Technische Dokumentation – Fragen und Antworten zur Technischen Dokumentation

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Ja, sobald personenbezogene Daten verarbeitet oder dokumentiert werden – zum Beispiel in Nutzerprofilen, Fehlerberichten, Tracking-Logs oder Schulungsunterlagen – greift die DSGVO.

Was versteht man unter technischem Lektorat?

Im Rahmen des Lektorats geht es um die Überprüfung von Texten hinsichtlich der Einhaltung grammatikalischer, rechtschreiblicher und stilistischer Kriterien. Diese Prüfung wird gemeinhin für alle Texte unabhängig von ihrem Inhalt durchgeführt.

Kommen noch fachlich-inhaltliche Prüfkriterien hinzu, spricht man in der technischen Dokumentation vom technischen Lektorat. So wird hier geprüft, ob alle für das jeweilige Informationsprodukt gültigen Normen und Richtlinien eingehalten werden. Hierzu gehören beispielsweise die Prüfung auf Vollständigkeit, Plausibilität und Auszeichnung von Sicherheits- und Warnhinweisen, die Prüfung auf zielgruppengerechte Verständlichkeit, Dokumentenstruktur und einsatzbezogene Medienverwendung oder auf die Berücksichtigung von Besonderheiten für bestimmte Zielländer hinsichtlich der bildlichen Darstellung, Verständlichkeit, Farben oder allgemeinen Übersetzungskriterien (Lokalisierung).

Im Rahmen der Plausibilitätskontrolle (auch Plausibilitätsprüfung genannt) wird geprüft ob die technische Dokumentation grundsätzlich nachvollziehbar und damit für die Zielgruppe ausreichend verständlich ist. Dabei ist zu beachten, dass bei dieser Prüfung der rein technische Bereich im technischen Lektorat meist nicht berücksichtigt werden kann und die Prüfung in dieser Hinsicht dann nur geringe oder keine Aussagekraft besitzt.

Ja, sobald personenbezogene Daten verarbeitet oder dokumentiert werden – zum Beispiel in Nutzerprofilen, Fehlerberichten, Tracking-Logs oder Schulungsunterlagen – greift die DSGVO.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Nur wenn dies notwendig und rechtlich zulässig ist. Protokolle, Fehlermeldungen und Nutzeranalysen dürfen nicht dauerhaft mit Personenbezug gespeichert werden – nur anonymisiert oder pseudonymisiert.

• Keine personenbezogenen Daten ohne Rechtsgrundlage dokumentieren
• Anonymisierung, wenn möglich
• Datenschutz durch Technikgestaltung („Privacy by Design“) berücksichtigen
• Nur notwendige Daten erfassen („Datenminimierung“)

Personenbezogene Daten sind alle Informationen, die sich auf eine identifizierbare Person beziehen: Name, E-Mail-Adresse, IP-Adresse, Benutzerverhalten, Systemnutzungsdaten, Video- und Bildaufnahmen usw.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Nur wenn dies notwendig und rechtlich zulässig ist. Protokolle, Fehlermeldungen und Nutzeranalysen dürfen nicht dauerhaft mit Personenbezug gespeichert werden – nur anonymisiert oder pseudonymisiert.

• Keine personenbezogenen Daten ohne Rechtsgrundlage dokumentieren
• Anonymisierung, wenn möglich
• Datenschutz durch Technikgestaltung („Privacy by Design“) berücksichtigen
• Nur notwendige Daten erfassen („Datenminimierung“)

Personenbezogene Daten sind alle Informationen, die sich auf eine identifizierbare Person beziehen: Name, E-Mail-Adresse, IP-Adresse, Benutzerverhalten, Systemnutzungsdaten, Video- und Bildaufnahmen usw.

Ja, sobald personenbezogene Daten verarbeitet oder dokumentiert werden – zum Beispiel in Nutzerprofilen, Fehlerberichten, Tracking-Logs oder Schulungsunterlagen – greift die DSGVO.

Die richtigen Bildformate für eine Anleitung zu wählen, hängt immer vom Inhalt und der späteren Verwendung ab. Die folgende Übersicht zeigt welches Format das richtige ist.

Technische Zeichnungen oder schematische Darstellungen

✅ SVG (falls als Vektorgrafik verfügbar)
✅ PNG (für Pixelgrafik)
Warum:

• Klare Linien, verlustfreie Darstellung
• SVG ist unbegrenzt skalierbar
• PNG erhält Qualität auch bei Vergrößerung

Fotos von Produkten oder Anlagen

Empfohlen:
✅ TIF/TIFF für Druckdokumente
✅ PNG für digitale Verwendung
Warum:

• TIF ist verlustfrei, farbtreu, ideal für hochwertige Druckausgabe
• PNG ist kleiner, verlustfrei und kann Transparenz darstellen

Benutzeroberflächen/HMI

Empfohlen:
✅ PNG
Warum:

• Scharfe Darstellung von Text und UI-Elementen (HMI)
• Keine Artefakte wie bei JPEG

Andere Dateitypen:

JPEG – Schlechte Qualität bei mehrfacher Bearbeitung oder Skalierung, Verlustbehaftet, unscharfe Linien.

BMP – Veraltet, riesige Dateigröße, keine Transparenz, ineffizient.

GIF – Nur 256 Farben, keine Eignung für komplexe Darstellungen, sinnvoll bei Web-Animationen.

PDF – PDF ist ein Containerformat, eingebettete Bilder müssen extrahiert werden.

Was versteht man unter technischem Lektorat?

Im Rahmen des Lektorats geht es um die Überprüfung von Texten hinsichtlich der Einhaltung grammatikalischer, rechtschreiblicher und stilistischer Kriterien. Diese Prüfung wird gemeinhin für alle Texte unabhängig von ihrem Inhalt durchgeführt.

Kommen noch fachlich-inhaltliche Prüfkriterien hinzu, spricht man in der technischen Dokumentation vom technischen Lektorat. So wird hier geprüft, ob alle für das jeweilige Informationsprodukt gültigen Normen und Richtlinien eingehalten werden. Hierzu gehören beispielsweise die Prüfung auf Vollständigkeit, Plausibilität und Auszeichnung von Sicherheits- und Warnhinweisen, die Prüfung auf zielgruppengerechte Verständlichkeit, Dokumentenstruktur und einsatzbezogene Medienverwendung oder auf die Berücksichtigung von Besonderheiten für bestimmte Zielländer hinsichtlich der bildlichen Darstellung, Verständlichkeit, Farben oder allgemeinen Übersetzungskriterien (Lokalisierung).

Im Rahmen der Plausibilitätskontrolle (auch Plausibilitätsprüfung genannt) wird geprüft ob die technische Dokumentation grundsätzlich nachvollziehbar und damit für die Zielgruppe ausreichend verständlich ist. Dabei ist zu beachten, dass bei dieser Prüfung der rein technische Bereich im technischen Lektorat meist nicht berücksichtigt werden kann und die Prüfung in dieser Hinsicht dann nur geringe oder keine Aussagekraft besitzt.

Für Konsumgüter stehen Nutzungsinformationen häufig auch per Video parat. In den Videos müssen die Benutzer auch über mögliche Gefahren im Umgang mit dem Produkt in irgendeiner Form informiert werden. Dies kann über verbale oder nonverbale Warnhinweise im Video erfolgen.

Generell ist das Thema „Warnhinweise in Videos“ eine aus redaktioneller Sicht recht komplexe Herausforderung und es gibt noch keine „allgemeingültige, optimale“ Lösung. Videos erfordern Drehbücher, professionelle Ausrüstung, Programme, Erfahrung und mehr. Denn ein Video sollte auch entsprechend gut gemacht sein. Daher ist ein Einfaches oder sehr schnelles Realisieren solcher Videos kaum möglich. Meist kann man (zumindest in der Anfangsphase) je Filmminute mit mindestens eine Arbeitsstunde Aufwand rechnen, bis die Filmminute fertig ist. Das Erstellen des Drehbuchs, Planen des Drehortes, über das Filmen von Handlungen, hin zum Schneiden, Kontrollieren, Publizieren des Videomaterials nimmt halt entsprechend viel Zeit in Anspruch.

Ein agiles Projektmanagement ist den Mitarbeitern und Mitarbeiterinnen einer Technischen Redaktion nicht unbekannt. Es ist möglich ein Dokumentationsprojekt modulbasiert bzw. Topic-orientiert innerhalb kleinen agilen Teams aufzuteilen. Daraus lassen sich Arbeitspakete ableiten wie Transport, Betrieb oder Wartung. Die ganzen Arbeitspakete werden gesammelt, nach Ihrer Priorisierung aufgeteilt und dann von den Teams abgearbeitet. Die Teams befassen sich zuerst mit denen Paketen, welche die höchste Priorisierung haben. Welches der Personen im Team gerade an welchem Paket arbeitet, stimmen die Teammitglieder in einem täglichen Meeting ab.

Ein agiles Projektmanagement ist geeignet, um umfangreiche und komplexe Aufgabenstellungen in kleine Pakete zu packen. Diese Aufgabenpakete werden von kleinen Teams bearbeitet und im Team besprochen. So findet täglich ein kurzes Treffen von den Teams statt. Bei diesem wird besprochen, an was seit dem letzten Treffen gearbeitet wurde, welche Aufgaben bis zum nächsten Treffen bearbeitet werden sollen und ob es etwas gibt, was einen bei der Arbeit behindert. Am Ende der Bearbeitungsdauer eines Aufgabenpaketes findet ein Review statt, welches die Ergebnisse des Projektes zeigen und geprüft wird, ob alle Anforderungen des Projektes erfüllt wurden.

Jedes Dokumentationsprojekt kann auf diese Weise durchgeführt werden. Eine Technische Dokumentation setzt sich aus vielen kleinen Einheiten zusammen. Die Informationen für die Dokumentation werden modulbasiert bzw. Topic-orientiert innerhalb des kleinen Teams verteilt. Daraus lassen sich Arbeitspakete ableiten wie Transport, Betrieb oder Wartung, die von den einzelnen Teammitgliedern abgearbeitet werden.

Es ist sinnvoll, die Technische Dokumentation in logisch nachvollziehbare Bereiche und Abschnitte zu gliedern. Selten sehen sich Anwender jede einzelne Seite einer Technischen Dokumentation an. Da bieten sich Orientierungshilfen für den Anwender an. Mithilfe von Verzeichnissen wie Inhalts-, Abkürzungs-, Tabellenverzeichnis, Index oder Glossar kann man zudem die Technische Dokumentation sinnvoll in einzelne Abschnitte zur besseren Orientierung aufgliedern.

Ein Redaktionssystem erleichtert das Nachvollziehen von einzelnen Entwicklungsstände beim Erstellen einer Betriebsanleitung. Das Redaktionssystem erlaubt mit der eingebauten Versionierung die Änderungen in den einzelnen Ständen der Betriebsanleitung nachzuvollziehen. Dadurch kann man immer sehen, was sich in der letzten Version geändert hat. Jede Änderung an der Betriebsanleitung innerhalb des Redaktionssystems muss man zudem freigegeben, was die Kontrolle von Änderungen erleichtert.

Der Einsatz eines Redaktionssystems in der Technischen Dokumentation kann dann sinnvoll sein, wenn viele Betriebsanleitungen mit gleichen Inhalten zu erstellen sind. Das Erstellen, Verwalten, Publizieren und Übersetzen von Inhalten, die in der Technischen Dokumentation häufig vorkommen, ist mit einem Redaktionssystem einfacher. Ebenso wenn die erstellten Dokumente häufig zu überarbeiten sind aufgrund Versionsänderungen, lohnt sich der Einsatz eines Redaktionssystems. Die integrierte Versionkontrolle erlaubt es, dass man Änderungen in den Bausteinen leicht nachvollziehen kann.

Der Einsatz eines Redaktionssystems in der Technischen Dokumentation ist nicht immer sinnvoll. Wenn nur eine Betriebsanleitung zu erstellen ist, lohnt sich der initiale Aufwand für ein Redaktionssystem nicht. Ebenso wenn die Inhalte stark unterschiedlich ausfallen und nicht widerverwendbar sind, ist der Einsatz eines Redaktionssystem nicht geeignet.

Um die Inhalte im Abschnitt Wartung und Reinigung der Betriebsanleitung zu verdeutlichen, helfen Zeichnungen und Diagramme in der Technischen Dokumentation. Diese sollen beispielsweise verdeutlichen, in welchen Abständen Wartungsarbeiten durchzuführen sind. Zeichnungen in der Betriebsanleitung kann auch dabei unterstützen, wie eine Wartung durchzuführen ist.

Um einen Redaktionsleitfaden in der Technischen Dokumentation stilgerecht zu entwerfen, kann man sich an ein paar sprachliche Regeln halten.

Formulierungen im Redaktionsleitfaden sollten zum Beispiel kein Passiv enthalten. Der Benutzer ist mit dem Text aktiv anzusprechen.
Hierzu ein Negativbeispiel, wo diese Regel missachtet wird:

„Die Späneanhäufungen hinter der Werkzeugbeladetür sind zu entfernen.“

Nach der Optimierung lautet der Satz:

„Entfernen Sie die Späneanhäufungen hinter der Werkzeugbeladetür.“

Die Satzlänge ist ebenfalls relevant. Länge Schachtelsätze sollte man vermeiden. Allgemein sollten Sätze im Redaktionsleitfaden nicht länger als 20 Wörter sein.
Auch sollte man im Text auf Modalverben wie bspw. „dürfen“, „können“ und „mögen“ verzichten. Diese Begriffe suggerieren dem Benutzer Möglichkeiten. Die Notwendigkeiten der Anweisungen für einen Redaktionsleitfaden in der Technischen Dokumentation müssen entsprechend formuliert sein.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Ein Redaktionsleitfaden in der Technischen Dokumentation ist kein Regelwerk. Er dient mehr dazu, die Anwender zu schulen. Deswegen sollten Inhalte gut und übersichtlich strukturiert sein. Beispiele verdeutlichen die Inhalte noch besser. Für einen Redaktionsleitfaden gilt: Je länger und dichter der Leitfaden, desto mehr muss er als Nachschlagewerk funktionieren.

Der Redaktionsleitfaden enthält eine Vielzahl an Vorgaben, die für die Erstellung von der Technischen Dokumentation innerhalb einer Redaktion verbindlich sind. Zudem benötigt die Erstellung eines Redaktionsleitfaden eine Menge Zeit. Der Zeitaufwand rechnet sich durch die verbesserte Konsistenz und Qualität der aus dem Leitfaden erstellten Dokumente.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Redaktionssysteme dienen zur Verwaltung der Technischen Dokumentation und den Metadaten wie Datenstruktur und Layout des Inhaltes. Das Spektrum an Funktionen umfasst unter anderem das Erstellen, Verwalten, Publizieren und Übersetzen von Inhalten. Zudem ist durch die modulare Arbeitsweise mit dem Redaktionssystem eine Versionskontrolle für die erstellten Dokumente vorhanden. Hierdurch kann man Änderungen in der Technischen Dokumentation leicht nachvollziehen.

Single Source Publishing steht für einen XML-Standard, auf dem moderne Redaktionssysteme in der Technischen Dokumentation basieren, die den Vorteil bieten, dass den Inhalt und Layout voneinander getrennt verwaltet. Der Content muss mann dann nicht unnötig mehrfach verwalten und kann diesen medienunabhängig nutzen. Diese Prozesse werden von spezieller Software unterstützt. Dabei geht es um die weitgehende Trennung von Inhalt, Struktur und Layout. Single-Source-Publishing bietet die Möglichkeiten, um die Datenverwaltung sinnvoll zu gestalten.

Dank der Wiederverwendbarkeit der Bausteine lassen sich die Betriebsanleitungen jeder Maschinenvariante nahezu automatisch aus dem System heraus generieren. Änderungen und Korrekturen an den Inhalten der Technischen Dokumentation nimmt man nur an einer zentralen Stelle vor. Die Änderungen und Korrekturen passen sich dann in allen betreffenden Dokumenten an.

Eine gute und verständliche Technische Dokumentation verringert Risiken, reduziert den Supportaufwand und erhöht die Kundenzufriedenheit. Zudem vermeidet eine klare und verständliche interne Sprache Fehler und beschleunigt Prozesse. Außerdem erhöht eine einheitliche Terminologie für Fachbegriffe (wie z. B. NiO, Schütz, usw.) die Verständlichkeit für den Nutzer der Technischen Dokumentation.

Terminologie in der Technischen Dokumentation sind die Einheitliche Formulierung von Fachbegriffen. Eine Betriebsanleitung für eine Maschine oder ein Gerät muss auch für Laien verständlich formuliert sein. Dabei sollte man gänzlich auf Synonyme verzichten und stattdessen auf konsistente Wiederholungen setzen. Ein Glossar mit den speziellen Fachausdrücken erleichtert die Einhaltung der erforderlichen Terminologie. Sinnvoll wäre auch die Anlegung einer Terminologiedatenbank. Sie bildet zudem eine gute Voraussetzung für spätere Übersetzungsarbeiten.

Text und Bild in der Technischen Dokumentation stellt eine sinnvolle Kombination dar, um eine Betriebsanleitung logisch und verständlich zu gestalten. Beide Komponenten ergänzen sich gegenseitig und sorgen damit für eine gut strukturierte Übersicht. Dies führt dazu, dass sowohl die motorische als auch die visuelle Wahrnehmung angesprochen wird. Der Benutzer erkennt die Botschaft auf einen Blick. Je leichter er die Anweisungen umsetzen kann, desto eher befolgt er die Hinweise in der Technischen Dokumentation und erhöht somit auch die Sicherheit im Gebrauch mit dem Produkt.

Videos sind in Marketing und Vertrieb bereits ein beliebtes Mittel, um Kaufentscheidungen zu beeinflussen. In der Technischen Dokumentation können Videos zudem als spontanes Kommunikationsmittel eingesetzt werden. Eine Maschine oder ein Fertigungsprozess kann mit einer Kamera aufgenommen und von der Technischen Redaktion bearbeitet sein. Es ist damit zu rechnen, dass sich in den kommenden Jahren vermehrt audiovisuelle Inhalte in den Arbeitsalltag integrieren.

Videos in der Technischen Dokumentation kaschieren Leseschwächen der Anwender und erhöhen die Akzeptanz von Anleitungen. So können erklärende Videos als Add-on zur Papieranleitung die Verständlichkeit einer Maschine erhöhen. Die Erstellung von Videos führt dafür aber auch zwangsläufig zur Erhöhung der Dokumentationskosten. Die Technischen Redakteure benötigen neue Kompetenzen und Erfahrungen. Ob der Kunde die (teuren) Zusatzleistungen honoriert ist auch nicht gesichert.

Die Möglichkeiten für den Einsatz von Videos in der Technischen Dokumentation können in folgende Aufnahmesituationen unterteilt werden:

• Bewegtes Objekt: Zum Beispiel ein Technisches Produkt in Bewegung
• Animation: Abläufe in künstlicher Bewegung dargestellt
• Moderation: Aufnahme eines Sprechers oder einer Sprecherin
• Übersichtsfilm: Übersicht über eine Maschine beispielsweise durch Schwenken und Zoomen auf Details

Für die Technische Dokumentation sind folgende Kategorien von Produktionsformaten interessant:

• Prozessdokumentation: Zum Beispiel Abläufe einer Maschine auf Videos aufnehmen
• Screencasts: Beispielsweise die Aufzeichnung des Computerbildschirms
• Utility Filme: Kurze Videoclips als Anleitungsersatz
• Interner Wissensaustausch: Videos zum Informationsaustausch

Ein Screencast in der Technischen Dokumentation bietet einen ausgefallenen Weg zur Dokumentation einer Softwareanwendung. Zum Beispiel könnte ein Ingenieur eine neue Funktion an der Software einer Maschine erklären, während er seinen Bildschirm aufzeichnet. Mit einfachen Mitteln und bei entsprechender Nachbearbeitung können diese Aufnahmen in der Technischen Dokumentation eingesetzt werden.

Utility Filme in der Technischen Dokumentation kommen meist ohne Tonspur aus und eignen sich deswegen gut für den internationalen Gebrauch. Die sprachfreien und interaktiven Anleitungsvideos bestehen aus kurzen Videoclips, die miteinander verlinkt sind. Der Anwender kann sich die Aufgaben aus der Technischen Dokumentation Schritt für Schritt ansehen. Parallel dazu führt er die Handlung an der Maschine durch.

Wissen, Feedback oder Veränderungen in der Technischen Dokumentation können mit spontanen Bildschirm- oder Kameraaufnahmen weitergegeben werden. Durch solche Videos kann ein effizienter Informationsaustausch zwischen Technischen Redakteuren und anderen Abteilungen stattfinden. Der Aufwand für die Aufnahmen sollte man aber möglichst gering halten, da die Anzahl der Abrufe solche Videos gering ist.

Bestimmte Arbeitsschritte dürfen bei Videos in der Technischen Dokumentation ebenso wenig ausgelassen werden wie bei der Papierdokumentation. Dort sollte man für die Erstellung von Videos beachten:

• Konzeption eines Videos mithilfe eines Drehbuchs und Storyboards
• Sorgfältige Vorbereitung für den Dreh und angemessene Videoausrüstung
• Professioneller Videoschnitt mit Anpassung auf die Bedürfnisse der Zielgruppe
• Prüfung der Ergebnisse durch die Fachabteilungen

Ein Video in der Technischen Dokumentation sollte vorrangig informativ und bildend sein. Die Inhalte müssen zudem akkurat recherchiert und qualitativ hochwertig sein. Die Dauer eines Videos in der Technischen Dokumentation sollte kurz gehalten sein, die bevorzugte Länge liegt zwischen ein bis sechs Minuten. Ein oft unterschätzter Faktor in Videos in der Technischen Dokumentation ist eine gute Tonunterlegung. Sprecherkommentare und dezente musikalische Untermalung in guter Tonqualität erhöhen dabei den Mehrwert eines Videos.

Wir können für die Erstellung von Bedienungsanleitungen, Gebrauchsanleitungen oder Montageanleitungen mit mehreren, unterschiedlichen Redaktionssystemen arbeiten und umgehen. Daher sind wir sehr flexibel bei der Erstellung von Ihrer Anleitung. Wir arbeiten mit dem von Ihnen gewünschten System, entsprechend Ihrer Situation. Zudem können wir die Bedienungsanleitung, Gebrauchsanleitung oder Montageanleitung auch als InDesign oder Word ausliefern.

Der Redaktionsleitfaden dient als ein frei zugänglicher Wissenspool beim Erstellen von redaktionellen Dokumenten. Der Redaktionsleitfaden wird unterstützend für die Erstellung und Gestaltung von Betriebsanleitungen eingesetzt. Alle Dokumente sollen in Bezug auf Layout und Text dank einem dafür vorhergesehen Redaktionsleitfaden einheitlich entstehen. Damit soll ein hohes Qualitätsniveau bei der Technischen Dokumentation erreichbar sein. Bei den Lesern der Dokumente fördert dies den Wiedererkennungseffekt und gesuchte Inhalte sind dadurch leicht zu finden. Weiterhin dient er als Nachschlagewerk für die tägliche Arbeit oder auch als Hilfsmittel für die Einarbeitung neuer Kollegen.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Ein Redaktionsleitfaden kann viele Themen behandeln. Zum Beispiel können Layoutvorgaben, Terminologie und Informationsverteilung für Dokumente in einem Redaktionsleitfaden geregelt sein. Weiterhin können verwendete Tools für die Bild- und Mediennutzung in einem Leitfaden abgebildet sein. Auch Schritt-für-Schritt-Anleitungen für Prozessabläufe können mithilfe eines Redaktionsleitfaden beschrieben werden.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Ein Redaktionssystem in der Technische Dokumentation dient zur Verwaltung von Dokumenten und Metadaten wie Datenstruktur und Layout des Inhaltes einer Betriebsanleitung. Das Spektrum an Funktionen umfasst dementsprechend das Erstellen, Verwalten, Publizieren und Übersetzen von Inhalten. Durch die modulare Arbeitsweise mit Redaktionssystemen ist eine Versionskontrolle für die erstellten Dokumente, anhand man Änderungen leicht nachvollziehen kann, möglich. Wenn Sie für Ihre Technische Dokumentation ein Redaktionssystem nutzen wollen, helfen wir Ihnen gerne dabei.

Wichtige Informationen in Abbildungen sollten mit Vermerken gekennzeichnet sein. Eine Legende unter der Abbildung, die solche Vermerke erläutert, ist dabei behilflich. Besonders umfangreiche Darstellungen mit viel Informationsgehalt besser auf mehrere Abbildungen aufteilen.

Die Abbildungen nicht mit Informationen in Textform belasten. Wenn die Betriebsanleitung in andere Sprachen übersetzt werden soll, behindern Texte in Abbildungen die Arbeit der Übersetzer. Diese müssen dann in manueller Arbeit die Texte aus den Abbildungen heraus übersetzen und nachsetzen. Dadurch steigen die Kosten für die Übersetzung.

In der Technischen Dokumentation ist die Nutzung von Abbildungen auf verschiedene Arten möglich. Darunter fallen:

• Technische Illustrationen wie bspw. Schemazeichnungen, Ablaufdiagramme oder Funktionsdarstellungen
• Fotografien von Maschinen, Bauteile, Werkzeuge, usw.
• 3D-Abbildungen von z.B. Übersichtsdarstellungen, Schnittansichten, Explosionsdarstellungen
• Symbolische Abbildungen wie bspw. Piktogramme und Symbole

Um den Informationsgehalt einer Abbildung auf das Wesentliche zu beschränken geht man am besten wie folgt vor:

• Beschneiden der Abbildung: Dem Betrachter nur den wesentlichen Teil eines Bildes zeigen, indem die relevanten Informationen enthalten sind
• Freistellen der Abbildung: Unwesentliche Informationen im richtigen Bildausschnitt ausblenden
• Hervorheben von Informationen: Technische Hilfsmittel wie Markierungen, Pfeile, usw. verwenden, um kurzum bestimmte Informationen hervorzuheben