Inhaltskonzepte für die Technische Dokumentation

Eine Dokumentation muss zum vollständigen und sicheren Gebrauch eines Produkts anleiten. Damit ist allerdings noch nichts darüber gesagt, welche Informationen in einer Anleitung zu vermitteln sind. Die erforderlichen Inhalte sind im Wesentlichen abhängig davon, welche Funktion die Anleitung übernimmt und an wen sie sich richtet. Die Bedienungsanleitung für den Endanwender benötigt andere Inhalte als die Serviceanleitung für die eigenen Techniker.

Ein Inhaltskonzept muss nicht nur festlegen, welche Informationen vermittelt werden, sondern auch, wie das geschieht. Aus Anwendersicht geht es hier um einen möglichst unmittelbaren Zugriff auf die Information, aus Redakteurssicht um eine effiziente Erstellung und Wiederverwendung allgemein gültiger Informationen zwischen den Anleitungen.


Unser Vorgehen:

• Wir machen uns mit Ihren Produkten, deren Anwendungsfällen und den Zielgruppen vertraut.
• Wir entwickeln ein strukturelles Inhaltskonzept auf verschiedenen Ebenen – Dokumente, Kapitel, Abschnitte.
• Wir definieren das Inhaltskonzept auf der kommunikativen Ebene – Anleitungen, Beschreibungen, Warnhinweise, Text-Bild-Koordination.
• Wir definieren Formulierungs- und Gestaltungsvorgaben.
• Wir identifizieren mehrfach verwendbare Informationen, z. B. Warnhinweise, Einführung in die Dokumentation, Adressen, orientierende Grafiken.
• Wir erstellen exemplarische Musterseiten.
• Wir bilden die Regeln und Entscheidungen in Leitfäden und Redaktionswerkzeugen ab

Ihre Vorteile:

• Individuelle Anpassung Ihrer Dokumentation an Ihre Produkte, Zielgruppen und weitere Anforderungen
• Grundlage für die dokumentenübergreifende Wiederverwendung von Informationen
• Verschwendungsfreie Informationsvermittlung; in der Dokumentation steht nur genau das, was die jeweilige Zielgruppe für ihre Aufgabe benötigt
• Grundlage für eine industrielle, systemgestützte Zusammenstellung von Dokumentationen aus Informationsmodulen