Qualitätskriterien für funktionale Dokumente

Die Beurteilung von Dokumenten erfolgt unter ganz verschiedenen Aspekten. Bekannte Maßstäbe sind Verständlichkeit, Vollständigkeit, Übersichtlichkeit, Schönheit, Normenkonformität, Rechtssicherheit und weitere. Aber wann funktioniert ein Dokument wirklich? Wann unterstützt es den Anwender optimal bei seinen Aufgaben? Und wann ist ein Dokument so, dass es noch mit sinnvollem Aufwand gepflegt und übersetzt werden kann?

Lesen Sie hier, welche Qualitätskriterien ARAKonzept zugrunde liegen:


Systematik und Einheitlichkeit

Nutzen

Die generelle Systematik und Einheitlichkeit bewirkt, dass ...

  • der Anwender den Umgang mit den Dokumenten schnell implizit "lernen" kann, sich also sofort gut zurechtfindet,
  • der Wiederverwendungsgrad der Texte hoch ist, somit die Erstellungs- und Übersetzungskosten minimiert werden,
  • eine Dokumentationsumgebung aufgebaut wird, in der auch Nicht-Redakteure funktionale technische Dokumentation mit minimalem Aufwand erstellen können.


Bedeutung

Systematik und Einheitlichkeit ist das übergeordnete Qualitätskriterium, das auf alle Qualitätskriterien angewandt werden muss. Systematik und Einheitlichkeit muss umgesetzt werden bei

  • jeder Art von Strukturierung,
  • der Betitelungsstrategie,
  • der Navigations- und Verlinkungsstrategie,
  • den Formulierungen und der Terminologie,
  • der Gestaltung.

Ganz generell müssen vergleichbare Inhalte immer in gleicher Weise – orientiert an den Mustern – dargestellt werden.

Zielgruppen- und Zweckorientierung

Nutzen

Mit der Zielgruppen- und Zweckorientierung wird Folgendes erreicht:

  • Der Anwender wird optimal unterstützt.
  • Der Text wird minimiert: Die Dokumente enthalten so wenig Text wie möglich, aber soviel Text wie nötig, immer der Zielgruppe und dem Zweck angemessen.

 

Bedeutung

Zielgruppen- und Zweckorientierung bedeutet für Dokumente, dass ...

  • sie auf Fragen des Anwenders antworten sich an genau eine Zielgruppe richten, die genau das erfährt, was sie wissen muss
  • sich sauber voneinander getrennt an mehrere Zielgruppen richten, so dass jede Zielgruppe schnell das findet, was sie wissen muss
  • nur solche Texte enthalten, die ihren genau definierten Zweck haben, also a) zum Handeln anleiten – das ist der Hauptzweck der Dokumente und b) das Wissen vermitteln, das dazu benötigt wird
  • in kleine Teile gegliedert sind – die Frage-Antwort-Muster, auf c) je eine Frage antworten und d) einen Titel haben, sodass der Anwender die Antwort schnell findet

Strategie für Sicherheitsinformationen

Nutzen

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

Mit der Strategie für Sicherheitsinformationen wird Folgendes erreicht:

  • Der Anwender wird vollständig über mögliche Gefährdungen und entsprechende Gegenmaßnahmen informiert. Dabei wird seine aktuelle Situation – sich informierend, sprich lesend oder aktiv am Produkt handelnd – bei der Darstellung der Information berücksichtigt.
  • Der Ersteller kann die Vollständigkeit und Eindeutigkeit der Sicherheitsinformationen gewährleisten durch eine systematische Beziehung zwischen den in der Risikobeurteilung ermittelten Gefährdungen und den Sicherheitsinformationen im Dokument.

 

Bedeutung

Die Strategie für Sicherheitsinformationen bedeutet für Dokumente, dass sie ...

  • normen- und richtlinienkonform sind, denn auf den einschlägigen Anforderungen der Normen und Richtlinien für Produktdokumentation beruht die Strategie
  • sinnvoll – ohne "Warning Pollution" – vor Gefährdungen warnen und zu den Gegenmaßnahmen anleiten

Topic-Orientierung

Nutzen

Mit der Topic-Orientierung wird Folgendes erreicht:

  • Die Dokumente werden in überschaubare Informationseinheiten gegliedert.
  • Jede Informationseinheit behandelt nur ein Thema.
  • Die Dokumente bestehen aus wiederverwendbaren Bausteinen.
  • Multi-Channel-Publishing ist möglich.

 

Bedeutung

Ein Topic ist ein betiteltes Element, das ein Thema aus Anwendersicht behandelt.
Topics sind in Klassen typisiert, die abhängig vom Dokumenttyp bzw. der Branche sind. Bausteine der Topic-Klassen sind die Frage-Antwort-Muster.
Ein Topic ist strukturell gesehen ein nicht-hierarchisches Element. Daher kann er auf jeder Kapitelebene problemlos wiederverwendet werden.
Die Topic-orientierte Struktur ist druck- und bildschirmorientiert, daher ist Multi-Channel-Publishing unmittelbar ermöglich.

Sequenzierung auf Basis von Frage-Antwort-Mustern

Nutzen

Mit der Sequenzierung auf Basis von Frage-Antwort-Mustern wird Folgendes erreicht:

  • Der Anwender wird da abgeholt, wo er sich gerade gedanklich befindet.
  • Der Ersteller wird auf die Beantwortung der Anwenderfragen fokussiert.
  • Die Dokumente bestehen aus wiederverwendbaren Bausteinen.

 

Bedeutung

Frage-Antwort-Muster sind die funktionalen Informationseinheiten, die die eigentlichen Inhalte des Dokuments enthalten.

Ihre innere Struktur ist so, dass ihr Titel die Frage aufwirft und der Inhalt diese Frage beantwortet. Frage-Antwort-Muster stellen die Basiseinheiten des Topics dar.

Sie sind nach Anwenderfragen typisiert, die abhängig vom Dokumenttyp bzw. der Branche sind. Die Typen der Frage-Antwort-Muster sind die Bausteine der Topic-Klassen.

Ein Frage-Antwort-Muster ist strukturell gesehen ein nicht-hierarchisches Element. Daher kann es in verschiedenen Topics problemlos wiederverwendet werden. Die Frage-Antwort-Muster sind die kleinsten verwalteten Einheiten.

Strategie der Betitelung

Nutzen

Mit einer konsequenten Betitelungsstrategie wird Folgendes erreicht:

  • Der Anwender wird schnell zu den Antworten auf seine Fragen gelenkt.

 

Bedeutung

Alle Informationseinheiten sind betitelt. Dies gilt selbstverständlich für alle Kapitelebenen, aber eben auch für Topics und Frage-Antwort-Muster. Da überdies Topics und Frage-Antwort-Muster typisiert sind, wird themenorientiert eine Strategie entwickelt, die den Anwender zu den Antworten seiner Fragen führt.

Navigations- und Verlinkungsstrategie

Nutzen

Mit einer konsequenten Navigations- und Verlinkungsstrategie wird Folgendes erreicht:

  • Der Anwender kann die Antworten auf seine Fragen von jeder beliebigen Stelle aus leicht finden.

 

Bedeutung

Die Navigations- und Verlinkungsstrategie benutzt die folgenden prinzipiell möglichen Navigationsstrukturen:

  • Hierarchische Navigation, also Dokumentgliederung nach z. B. a) allgemeinen Strukturmustern oder b) normativen Strukturmustern
  • Advance Organizer: Gruppen zusammengehöriger Themen werden durch einen Advance Organizer eingeleitet, der c) Bezüge zu bekanntem Wissen herstellt, d) in allgemeine Konzepte einführt, e) auf folgende Informationen verlinkt
  • Systematische Links zwischen Topic-Klassen Aufbau von Link-Klassen

Durch geeignetes Zusammenspiel dieser Navigationsstrukturen wird erreicht, dass der Anwender von jeder beliebigen Stelle im Dokument zur Antwort seiner Frage findet.

Formulierungs- und Terminologieregeln

Nutzen

  • Mit der konsequenten Einhaltung von Formulierungs- und Terminologieregeln wird Folgendes erreicht: Die Sprache ist leicht verständlich und der Zielgruppe angemessen.
  • Der Text wird minimiert: Die Dokumente enthalten so wenig Text wie möglich, aber soviel Text wie nötig, immer der Zielgruppe und dem Zweck angemessen.

 

Bedeutung

Formulierungs- und Terminologieregeln stellen sicher, dass die Texte unmittelbar erfasst werden können und komplizierter Satzbau sowie komplexe, unklare Terminologie keine Verständnishürden darstellen.

Richtlinien für Gestaltung

Nutzen

Mit der konsequenten Einhaltung von Gestaltungsrichtlinien wird Folgendes erreicht:

  • Die Information ist übersichtlich präsentiert und schnell erfassbar.
  • Grafik und Layout unterstützen die Verständlichkeit des Textes.

 

Bedeutung

Gestaltungsrichtlinien stellen sicher, dass insbesondere die Frage-Antwort-Muster optisch schnell erkennbar sind, aber auch generell zusammengehörende Themen einen optischen Zusammenhang darstellen. Außerdem wird ein strikter Text-Bild-Bezug sichergestellt.