FAQ

FAQ

Häufig gestellte Fragen

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

Gegenfragen:

  1. Ist Ihre Dokumentation strukturiert?
  2. Wenn nein, wollen Sie zukünftig strukturiert arbeiten (xml)?
  3. Welchen Editor möchten Sie verwenden?
  4. Benötigen Sie die Features eines Content Management Systems?

2. Ist xml für unsere Dokumentation geeignet?

Das kommt ganz auf die Komplexität Ihrer Dokumentation an. Bei neuen Dokumentationen werden strukturierte Dokumente (xml) empfohlen.

3. Welche Ausbildung brauchen die Mitarabeiter in unserem Redaktionsteam?

Die Ausbildung mindestens eines Mitglieds des Teams als “Technischer Redaktor” (Redakteur) ist wünschenswert.

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 Redakteure 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. Ist es besser, alles für jeden Redakteur zuzulassen?
  2. Wie soll sonst eine durchgängig gleich strukturierte Dokumentation entstehen?
  3. Wird der Anwender, der Leser der Dokumentation nicht durch “Wildwuchs” eher verwirrt?
  4. Wie sollen sich die anderen Redakteure verhalten?

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”.