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…
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…
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,…
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,…
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…
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…
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…
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…
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…
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…