FAQ

FAQ

Häufig gestellte Fragen

1. Welches Tool ist für unsere Technische Dokumentation geeignet?

Das hängt von mehreren Faktoren ab, wie z.B.:

  1. Ist Ihre Dokumentation strukturiert?
  2. Wenn nein, möchten Sie zukünftig strukturiert arbeiten (xml)?
  3. Neigen Sie eher zu Office-Produkten (haben wir ja sowieso)?
  4. Welchen Editor möchten Sie verwenden?
  5. Benötigen Sie die Features eines Content Management Systems?
  6. Haben Sie ein Redaktionsteam?
  7. Mit welchen finanziellen Mitteln ist das Team ausgestattet?

2. Ist xml für unsere Dokumentation geeignet?

Das kommt ganz auf die Komplexität Ihrer Dokumentation an. Bei neuen Dokumentationen empfehlen wir strukturierte Dokumente in xml zu erstellen. Auch in der DIN EN 82079-1 wird die Trennung von Inhalt und Layout empfohlen.

3. Welche Ausbildung brauchen die Mitarbeiter in unserem Redaktionsteam?

Gemäss DIN EN 82079-1 müssen alle Mitarbeiter im Redaktionsteam eine angemessene Ausbildung haben.

4. Brauchen wir überhaupt ein Redaktionsteam?

Das ist abhängig von der Größe der Dokumentationen! Die Arbeit an einer lebenden Dokumentation wird im Allgemeinen sehr unterschätzt. Eine „Ein-Mann-Redaktion“ ist eher selten.

5. Wann braucht man eine Terminologie-Datenbank?

Sobald Termen in mehreren Dokumenten oder Publikationen vorkommen oder/und von mehreren Mitarbeitern einer Redaktion verwendet werden.

6. Wozu braucht man einen Redaktionsleitfaden (RLF)?

Sobald mehrere Redaktoren an einer Dokumentation arbeiten oder/und die Bearbeitung über einen langen Zeitraum geht, ist ein RLF notwendig und sinnvoll.

7. Wozu soll ich mir von einem Programm (Vorgaben, Applikation, Struktur) meine Arbeitsweise diktieren lassen („Ich lasse mir doch von einem Programm nichts diktieren!“)?

Gegenfragen!

  1. Sollen Redaktoren als freischaffende Künstler arbeiten?
  2. Wie soll eine durchgängig gleich strukturierte Dokumentation entstehen?
  3. Wird nicht der Anwender, also der Leser der Dokumentation durch „Wildwuchs“ verwirrt?

8. Aus welchen Elementen besteht eine Handlungsanweisung?

Eine Handlungsanweisung besteht aus Elementen des Funktionsdesigns®, z.B. Goal, Action, Result!

9. Was versteht man unter Funktionsdesign®?

Funktionsdesign® ist eine Schreibtechnik. Sie nutzt alle Möglichkeiten, um die
Problemvielfalt durch vorgefertigte Lösungen in den Griff zu bekommen.
Der funktionale Aspekt bildet den Kern der Planungs- und Schreibtechnik
„Funktionsdesign®“.