Informationen
Eigenschaften hochwertiger Dokumentation


Hochwertige technische Dokumentationen sind

  • zielgruppengerecht,
  • leicht verständlich und unmissverständlich,
  • lückenlos,
  • anwenderorientiert strukturiert,
  • gesetzes- und richtlinienkonform,
  • angemessen im Text-/Abbildungs-Verhältnis,
  • erstellerorientiert organisiert,
  • ansprechend gestaltet.

Als Folge daraus sind sie nachvollziehbar und benutzerfreundlich. Sie motivieren zum Lesen (und Weiterlesen) und sind sicherheitstechnisch einwandfrei. Die Aufwendungen für Änderungen und Übersetzungen sind minimal.

Verständlichkeit von Benutzerinformationen

Oft werden die oben genannten Eigenschaften unterschätzt. Gerade die Verständlichkeit von Dokumentationen, die teilweise mit anderen Eigenschaften verzahnt ist, wird vielfach nicht erreicht. So sind nach Befragungen 86% der Produkthersteller der Überzeugung, ihre Benutzerinformationen wären leicht verständlich. In Benutzer-Tests ist dem gegenüber jedoch festgestellt worden, dass nur 37% der Dokumentationen dieses Kriterium erfüllen. Ursache ist meistens die Erstellung durch unqualifiziertes Personal. Vergessen wird dabei oft, dass die Verständlichkeit zusammen mit vielen anderen Eigenschaften gesetzlich gefordert wird.

Voraussetzungen für Verständlichkeit: Sprachanwendung

Erreicht werden kann die Verständlichkeit nur, wenn nach allen Regeln der technischen Redaktion vorgegangen wird. Insbesondere die Sprachanwendung nimmt hier natürlich einen hohen Stellenwert ein. Sowohl auf der Wortebene als auch auf der Satzebene gibt es diverse Regeln zu berücksichtigen, z. B.

  • gebräuchliche Ausdrücke benutzen,
  • Verben statt Substantivierungen verwenden,
  • aktiv statt passiv formulieren,
  • Modalverben (sollen, können, dürfen) nur gezielt einsetzen,
  • konsequente Wortnutzung für gleiche Sachen,
  • kurze, einfache Sätze statt Satzketten,
  • gleichbleibender Sprachstil,
  • Schachtelsätze vermeiden.

Dokumentationsstruktur

Die Struktur der Dokumentation ist gleichermaßen wichtig.

Damit der Benutzer sich gut zurecht findet, sollten Sachverhalte getrennt und Sinnzusammenhänge geschaffen werden, z. B. durch eine geeignete Kapitelstruktur und eine handlungs-, produkt- oder lernorientierte Gliederung.

Funktionale Abbildungen verwenden

Eine große Bedeutung kommt auch der richtigen Mischung von Text und Abbildungen zu.

Bilder sind nicht nur motivierend, sie erfüllen auch bestimmte Funktionen besser als sprachliche Informationen.
Bei anschaulichen Merkmalen und räumlichen Zusammenhängen, die in einem Bild auf einem Blick ablesbar sind, ist man in reinen Textanleitungen auf umständliche Beschreibungen angewiesen.

Abbildungen sollten deshalb funktional gestaltet und überlegt eingesetzt werden. Die Bandbreite umfasst hier die Anwendung von Realfotos, fotorealistischen Zeichnungen, Strichzeichnungen, Schemazeichnungen, Visualisierungen und Piktogrammen.

Makrotypografie: Layout-Typen in der technischen Dokumentation

layout_1.gif 98x133 layout_2.gif 104x133 layout_3.gif 104x133 layout_4.gif 98x133
Typus
"Sandwich"
Typus
"Lift"
Typus
"Zwilling"
Typus
"Top"