Überspringen zu Hauptinhalt

Technische Dokumentation – Wie teilt man eine Betriebsanleitung in mehrere Dokumente auf?

Falls mehrere Dokumente die „Betriebsanleitung“ in einer Technischen Dokumentation ausmachen, muss der Zusammenhang der einzelnen Dokumente klar erkennbar sein. Dies kann man mithilfe von entsprechenden Verweisen und Verzeichnissen in allen Dokumenten sicherstellen. Dadurch ist ersichtlich, welches Dokument welchen Zweck erfüllen soll und welche Inhalte darin vorkommen. Die Inhalte in den Dokumenten sind „zielgruppengerecht“ aufzuteilen. Ein Montagehandbuch beschäftigt sich nur mit den Inhalten der Montage, das Wartungshandbuch nur mit den Inhalten zur Wartung und Instandhaltung. Vorhandene Inhalte, die übergreifend in mehreren Dokumenten anwendbar sind, sollte man aber nicht doppelt aufführen. Besser und sinnvoller ist es hierbei auf die jeweiligen anderen Teile der Anleitung zu verweisen.

An den Anfang scrollen