Technische Dokumentation

Der Einsatz eines Redaktionssystem in der Technischen Dokumentation ist kostspielig und die Einführung eines solchen Systems benötigt viel Zeit. Die Lizenzkosten für die Anschaffung eines Redaktionssystem unterschieden sich zudem von Anbieter zu Anbieter der Systeme. Häufig sind zusätzliche Funktionen über…

Der Einsatz eines Redaktionsleitfaden in der Technischen Dokumentation ist dann sinnvoll, wenn mehrere Redakteure unterschiedliche Informationsprodukte erstellen. Die Zusammenarbeit von mehreren Redakteuren ist anders als bei einer „Ein-Mann-Redaktion“, da jeder Beteiligte seine eigene Schreibweise und Stil hat. Auch um unterschiedliche…

Von einem Redaktionsleitfaden in der Technischen Dokumentation können mehrere Beteiligten profitieren. Das können neben den Technischen Redakteuren auch Konstrukteure, Entwickler oder externe Dienstleister sein. Grafiker und Illustratoren, die neben den Redakteuren separat arbeiten, zählen ebenfalls dazu. Aber auch andere Abteilungen…

Ein Redaktionssystem erleichtert in der Technischen Dokumentation die Verwaltung von vielen Betriebsanleitungen und deren einzelnen Entwicklungsstände. Eine eingebaute Versionierungsfunktion im Redaktionssystem erlaubt die Änderungen in den einzelnen Ständen leicht nachzuvollziehen. Dies ist dann hilfreich, wenn eine Betriebsanleitung häufig zu überarbeiten…

Um eine Maschine beim Transport sicher zu bewegen, muss in der Technischen Dokumentation auch Angaben zu dem Transport einer Maschine stehen. Dazu gehören Angaben zu den zulässigen Transportmitteln wie das die Maschine nur mit einem Gabelstapler zu bewegen ist. Die…

Die Technische Dokumentation muss auch Angaben zu der Verpackung einer Maschine enthalten. Dazu zählen beispielsweise die Angaben zum sicheren Auspacken der Maschine. Ebenso gilt es zu erläutern, wie die Maschine wieder zu verpacken ist. Sind mögliche (Rest-)Risiken beim Aus- bzw…

Die Technische Dokumentation von Zulieferer weißt mittels Sicherheitshinweise auf Gefahren hin. In wie weit es sinnig ist, in der eigenen Betriebsanleitung mit Sicherheitshinweise auf die Sicherheitshinweise der Zulieferer zu verweisen, hängt ganz von der Situation ab. Das Teil des Zulieferers…

In der Praxis hat sich ein gewisses Schema für den Aufbau einer Software Dokumentation etabliert. Zuerst beschreibt man die Grundlagen der Software. Die Anleitung beschreibt hierbei zuerst was für eine Funktion die Software hat und wie das Programm funktioniert. Danach…

Eine Software Dokumentation soll grundsätzlich drei Fragen rund um ein Programm erläutern. Wie funktioniert das Programm?Wie wird das Programm bedient?Wie wurde die Software entwickelt? Mit Beantwortung dieser Fragen deckt die Software Dokumentation auch alle unterschiedlichen Zielgruppen ab. Die Anleitung zu…

Das Schreiben einer Software Dokumentation unterscheidet sich von einer normalen Technischen Dokumentation. Wie die Anleitung für Software aufgebaut ist, hängt davon ab wie häufig man die Software verwendet. Bei einmaliger Nutzung möchte der Anwender schnell und ohne seitenlanges Lesen handeln…