Muster-Redaktionsleitfaden für die Technische Dokumentation

Einheitliche Regeln. Klare Prozesse. Konsistente Betriebsanleitungen.

Mit unserem Muster-Redaktionsleitfaden erhalten Sie eine praxisnahe Grundlage für den Aufbau eines eigenen unternehmensspezifischen Redaktionsleitfadens.

Das 46-seitige Muster zeigt, welche organisatorischen, methodischen, sprachlichen und gestalterischen Regeln innerhalb einer Technischen Redaktion festgelegt werden können. Statt bei null zu beginnen, greifen Sie auf eine bereits ausgearbeitete Struktur zurück und passen diese an Ihr Unternehmen, Ihre Produkte und Ihre internen Abläufe an.

Inhalte des Muster-Redaktionsleitfadens
Behandelt werden unter anderem:

• Zweck, Zielgruppen und Qualitätsanforderungen
• rechtliche und normative Anforderungen
• Recherche-, Erstellungs-, Korrektur- und Freigabeprozesse
• Dokumentenverwaltung, Archivierung und Aktualisierung
• Aufbau und Struktur von Betriebsanleitungen
• Funktionsdesign und Funktionale Einheiten
• Layout, Typografie und Visualisierung
• Abbildungen und Illustrationsarten
• Regeln für verständliche und konsistente technische Texte
• Terminologie und Formulierungsregeln

Viele sprachliche Vorgaben werden anhand konkreter Positiv- und Negativbeispiele erläutert.

Hinweis zu Normen, Richtlinien und Aktualität
Der Muster-Redaktionsleitfaden ist keine Normensammlung und kein Nachschlagewerk für den jeweils aktuellen Rechts- und Normenstand. Normen und Richtlinien werden im Muster exemplarisch behandelt, um zu zeigen, wie entsprechende Anforderungen in redaktionelle Prozesse und die Technische Dokumentation eingebunden werden können.
Die für ein konkretes Produkt geltenden gesetzlichen und normativen Anforderungen müssen daher immer aktuell und produktspezifisch ermittelt werden.

Der eigentliche Zweck des Musters liegt in den enthaltenen Strukturen, Prozessen, Qualitätsvorgaben und Schreibregeln für die Technische Redaktion.
Sie erwerben eine praxisorientierte und umfassend ausgearbeitete Grundlage für den Aufbau eines eigenen Redaktionsleitfadens, die individuell an Ihr Unternehmen und die jeweils aktuellen normativen Anforderungen angepasst werden kann.

Ihr Nutzen
Das Muster hilft Ihnen dabei,

• einen eigenen Redaktionsleitfaden schneller aufzubauen,
• redaktionelle Abläufe zu standardisieren,
• einheitliche Qualitätsmaßstäbe festzulegen,
• Schreib- und Gestaltungsregeln verbindlich zu definieren,
• Abstimmungsaufwand zu reduzieren und
• neue Mitarbeiter schneller einzuarbeiten.

Für wen eignet sich das Muster?
Das Muster richtet sich insbesondere an Technische Redakteure, CE-Verantwortliche, Qualitätsmanagement, Konstrukteure und Entwickler sowie Unternehmen, die ihre Technische Dokumentation systematisch standardisieren möchten.

Lieferumfang
Sie erhalten einen 46-seitigen Muster-Redaktionsleitfaden für die Erstellung von Betriebsanleitungen (Dateiformat Microsoft Word und PDF).

Hinweis:
Das Muster dient als Vorlage und muss an die individuellen Produkte, Prozesse, Verantwortlichkeiten sowie die aktuell geltenden gesetzlichen und normativen Anforderungen angepasst werden.