Qualitätskriterien für Dokumente

Es gibt ganz verschiedene Aspekte, um Dokumente zu beurteilen. Solche Kriterien sind z.B. Verständlichkeit, Vollständigkeit, Übersichtlichkeit, Gestaltung, Normenkonformität und Rechtssicherheit. Aber wann funktioniert ein Dokument wirklich? Wann unterstützt es den Anwender bei seinen Aufgaben? Und wie baut man man ein Dokument so auf, dass man es mit sinnvollem Aufwand pflegen und übersetzen kann?

Auf dieser Seite beschreiben wir die Qualitätskriterien für Dokumente, die nach ARAKonzept aufgebaut sind.

Systematik und Einheitlichkeit

Dokumente sollen systematisch und einheitlich sein. Vergleichbare Inhalte werden immer in gleicher Weise – orientiert an Mustern – dargestellt.

  • Dadurch lernen Anwender den Umgang mit den Dokumenten schnell und finden sich sofort gut zurecht.
  • Texte könnten gut wiederverwendet werden, die Kosten für Erstellung und Übersetzung sinken.
  • Auch Nicht-Redakteure können funktionale technische Dokumentation mit geringem Aufwand erstellen.

Systematik und Einheitlichkeit sind grundlegende Qualitätskriterien. Sie gelten für jede Art von Strukturierung, die Betitelung, Navigation und Verlinkung, Formulierungen und Terminologie sowie die Gestaltung.

Zielgruppen- und Zweckorientierung

Dokumente sollen sich an ihren Zielgruppen und am Zweck orientieren.

  • Dadurch sind sie genau auf den Anwender zugeschnitten und unterstützen ihn.
  • Außerdem werden die Texte kürzer: Die Dokumente enthalten so wenig Text wie möglich, aber soviel wie nötig. Sie sind der Zielgruppe und dem Zweck angemessen.

Dadurch verändern sich die Dokumente:

  • Sie antworten genau auf die Fragen des Anwenders.
  • Sie richten sich an genau eine Zielgruppe. Diese erfährt genau das, was sie wissen muss.
  • Die Inhalte für unterschiedlichen Zielgruppen sind klar getrennt, so dass jede Zielgruppe schnell das findet, was sie wissen muss.
  • Sie enthalten nur solche Texte, die den definierten Zweck erfüllen: Entweder leiten sie zum Handeln an (das ist der Hauptzweck der Dokumente), oder sie vermitteln das dazu nötige Wissen.
  • Die Dokumente sind in kleine Bestandteile gegliedert, die auf jeweils eine Frage antworten und einen Titel haben, sodass der Anwender die Antwort schnell findet. Diese Bestandteile sind die Frage-Antwort-Muster.

Strategie für Sicherheitsinformationen

Sicherheitsinformationen sollen den Anwender befähigen, das Produkt – z. B. die Maschine – ohne Gefährdung für sich und andere zu benutzen. Sie sollen zudem den Betreiber des Produktes in die Lage versetzen, seine Mitarbeiter so einzuweisen, dass sie die Maschine ohne Gefährdung für sich und andere benutzen können.

  • Der Anwender wird vollständig über mögliche Gefährdungen und entsprechende Gegenmaßnahmen informiert. Die Darstellung der Information berücksichtigt die aktuelle Situation des Anwenders: Er informiert sich oder er handelt aktiv.
  • Es gibt eine systematische Beziehung zwischen den Gefährdungen, die in der Risikobeurteilung ermittelt wurden, und den Sicherheitsinformationen. Dadurch können die Sicheheitsinformationen vollständig und eindeutig erstellt werden.

So entstehen Dokumente, die konform zu Normen und Richtlinien sind. Sie warnen vor Gefährdungen und leiten zu Gegenmaßnahmen an, ohne ausufernde „Warning Pollution“.

Topic-Orientierung

Mit AraKonzept erstelle Dokumente basieren auf Topics. Das heißt:

  • Dokumente werden in überschaubare Informationseinheiten gegliedert. Jede Informationseinheit behandelt nur ein Thema.
  • Dokumente bestehen aus wiederverwendbaren Bausteinen.
  • Dokumente funktionieren sowohl für die Druckausgabe als auch auf allen Bildschirmen.

Ein Topic ist ein betiteltes Element, das ein Thema aus Anwendersicht behandelt.

  • Je nach Dokumenttyp oder Branche gibt es unterschiedliche Klassen von Topics.
  • Topics sind aus Frage-Antwort-Mustern zusammengesetzt.
  • Ein Topic ist ein nicht-hierarchisches Element. Daher funktioniert es auf jeder Kapitelebene.

Sequenzierung mit Frage-Antwort-Mustern

Topics wiederum sind aus Frage-Antwort-Mustern aufgebaut.

  • Der Anwender wird dort abgeholt, wo er sich gedanklich befindet.
  • Der Ersteller kann sich die Beantwortung der Anwenderfragen fokussieren.
  • Die Dokumente und ihre Topics bestehen aus wiederverwendbaren Bausteinen.

Die Frage-Antwort-Muster enthalten die eigentlichen Inhalte des Dokuments.

  • Ihr Titel wirft eine Frage auf, und ihr Inhalt beantwortet diese Frage.
  • Die Frage-Antwort-Muster sind die Basiseinheiten für Topics.
  • Abhängig vom Dokumenttyp oder der Branche gibt es unterschiedliche Typen von Frage-Antwort-Mustern.
  • Ein Frage-Antwort-Muster ist ein nicht-hierarchisches Element. Es kann problemlos wiederverwendet werden.
  • Die Frage-Antwort-Muster sind die kleinsten verwalteten Einheiten.

Strategie der Betitelung

Eine konsequente Betitelung lenkt den Anwender schnell zu den Antworten auf seine Fragen.

Dafür erhalten alle Informationseinheiten einen Titel. Dies gilt für Kapitel genauso wie für Topics und Frage-Antwort-Muster. Außerdem sind Topics und Frage-Antwort-Muster typisiert. Sie führen damit den Anwender themenbezogen zu den Antworten seiner Fragen.

Navigations- und Verlinkungsstrategie

Durch eine konsequente Navigation und Verlinkung findet der Anwender die Antworten auf seine Fragen von jeder beliebigen Stelle aus.

Dafür gibt es folgende Navigationsstrukturen:

  • Es gibt eine hierarchische Navigation, also eine Dokumentgliederung nach allgemeinen oder normativen Strukturmustern (z.B. ein Inhaltsverzeichnis).
  • Ein „Advance Organizer“ leitet Gruppen zusammengehöriger Themen ein. Er stellt Bezüge zu bekanntem her, führt in allgemeine Konzepte ein oder verlinkt auf nachfolgende Informationen.
  • Es gibt systematische Links zwischen Topic-Klassen durch einen Aufbau von Link-Klassen.

Formulierungs- und Terminologieregeln

Es gibt Regeln für Formulierungen und die Terminologie.

  • Die Sprache ist leichter verständlich und der Zielgruppe angemessen.
  • Die Texte werden kürzer: Die Dokumente enthalten so wenig Text wie möglich, aber soviel wie nötig, immer der Zielgruppe und dem Zweck angemessen.

Durch Regeln für die Formulierung und Terminologie kann der Anwender Texte leichter erfassen. Es gibt weniger Verständnisprobleme durch komplizierten Satzbau oder komplexe, unklare Terminologie.

Richtlinien für Gestaltung

Es gibt klare Richtlinien für die Gestaltung von Dokumenten.

  • Dadurch werden Information übersichtlich präsentiert und können schnell erfasst werden.
  • Außerdem unterstützen Grafik und Layout die Verständlichkeit des Textes.

Eine klare Gestaltung macht die Frage-Antwort-Muster optisch schnell erkennbar. Zusammengehörende Themen erhalten auch einen optischen Zusammenhang. Außerdem gibt es einen eindeutigen Text-Bild-Bezug.