Die perfekte Technische Dokumentation

Veröffentlicht: 02.09.2021 Aktualisiert: 22.08.2022
Thema: Qualitätssicherung Content-Erstellung

Perfekt ist natürlich niemand, auch keine Dokumentation. Aber man wird ja noch träumen dürfen. Wie sähe sie denn aus, die perfekte Dokumentation? Was wäre eine Dokumentation, die nicht nur vorhanden ist, sondern die man auch gerne zur Hand nimmt?

Die perfekte Technische Dokumentation

Perfektion liegt im Auge des Benutzers

Was bedeutet nun eigentlich perfekt? Vermutlich bedeutet es für jeden etwas anderes. Perfektion liegt im Auge des Betrachters, um ein bekanntes Sprichwort umzudeuten. Perfektion sollte man auf jeden Fall von der Zielgruppe her denken, von den Nutzern.

Nimmt man diese Perspektive ernst, dann ergeben sich auch einige eindeutige Kriterien. Da sind zunächst einmal die Kernanforderungen an jede Dokumentation: Eindeutig, verständlich, vollständig, sicher sollte ein Handbuch sein, damit die Nutzer zuverlässig damit arbeiten können. Hat man diese Anforderungen erfüllt, dann hat man zumindest schon mal nichts verkehrt gemacht. Allerdings reicht „zuverlässig“ noch nicht aus für die Dokumentation, denn wir wollen ja Perfektion.

Was braucht Perfektion also noch? Mit den bisherigen Kriterien ist Dokumentation in etwa auf dem Niveau eines Telefonbuchs: Kann man schon verwenden, nur Spaß macht es nicht und man nimmt es erst dann in die Hand, wenn es gar nicht mehr anders geht. Eine perfekte Anleitung muss also den Nutzer auch ansprechen, sie muss im Idealfall dazu einladen, sich mit dem Produkt zu beschäftigen. In der Technischen Redaktion haben sich hierfür in den letzten Jahren vor allem zwei Ansätze entwickelt. Zum einen das Konzept des Minimalismus bzw. der minimalen Anleitung. Im Zentrum steht hier, dass der Nutzer so wenig Information wie möglich rezipieren soll, um das Produkt nutzen zu können. Das andere Konzept, Gamification, setzt bei der Motivation des Nutzers an. Durch die Integration von Spielelementen versucht man hier die Bereitschaft der Nutzer zu erhöhen, sich mit dem Produkt auseinanderzusetzen.

Sind wir damit nun bei der perfekten Dokumentation angelangt? Tatsächlich immer noch nicht. Denn nun kommt noch einmal der Aspekt „Perfektion liegt im Auge des Betrachters“ in den Fokus. Wir alle haben unsere eigenen Lesegewohnheiten, Vorlieben, sind unterschiedliche Lerntypen und wollen Texte in unterschiedlichen Situationen lesen (oder vielleicht auch gar nicht lesen, sondern als Video ansehen). Die perfekte Dokumentation richtet sich deshalb nach meinen Vorlieben und lässt mich entscheiden, wie ich welchen Content wann wahrnehme.

Perfektion auf den Weg gebracht

Fassen wir also noch einmal zusammen: Die perfekte Dokumentation ist eindeutig, verständlich, sicher und vollständig. Sie befriedigt die Informationsbedürfnisse der Nutzer mit möglichst wenig Informationslast und bietet einen einfachen und angenehmen Informationszugang. Gleichzeitig sorgt sie aber auch durch gestalterische und interaktive Elemente dafür, dass die Nutzer zur Verwendung der Dokumentation motiviert werden. Und zu guter Letzt ist die Darstellung der Dokumentation so flexibel, dass sie vielfältige Nutzungsgewohnheiten und -situationen unterstützen kann.

Die perfekte Dokumentation, ist die, die gelesen wird. Je nahtloser sich die Anleitung in die Nutzungssituation einfügt, desto besser. Denn die perfekte Dokumentation ist nicht immer ein Dokument. Sondern manchmal nur – zum Beispiel - ein Informationsschnipsel auf dem Maschinendisplay.

Stellt sich also nur noch die Frage, wie man das alles umsetzen soll. Nun könnte man sich an diesem Punkt leicht zurücklehnen und sagen: „Wer ist schon perfekt? Wenn Perfektion sowieso nicht möglich ist, dann brauche ich das auch gar nicht zu versuchen.“ Wie so oft ist aber auch hier der Weg das Ziel. Und auf diesem Weg bringen Sie zwei Dinge ein gutes Stück voran: Ein gutes Content-Konzept (mit einer entsprechenden Content-Architektur) und ein wegbereitendes Component Content Management System (denn nur das bietet eine wirklich flexible Informationsbereitstellung).

Falls Sie sich nun fragen, wie Sie an diese Wegbereiter kommen: Nun, wir hätten da so eine Idee...

Andere Artikel von Quanos

Das könnte Sie auch interessieren

SCHEMA Solutions - Wenn man auf die Rennstrecke muss

SCHEMA Solutions - Wenn man auf die Rennstrecke muss

Technische Redaktion software-gestützt. Diese Philosophie setzen wir bereits bei hunderten Kunden mit den Standard-Au…

Augmented Reality mit SCHEMA ST4 - Miele zeigt, wie's geht

Augmented Reality mit SCHEMA ST4 - Miele zeigt, wie's geht

Ein Kunde steht vor seinem Wäschetrockner. Er möchte das Flusensieb reinigen. Anstatt das "Wie" in der gedruckten Anl…

Workflow Designer bei Positive Technologies - Optimale Integration von Menschen, Werkzeug und Prozessen

Workflow Designer bei Positive Technologies - Optimale Integration von Menschen, Werkzeug und Prozessen

Wer hohe Ansprüche an die Content-Qualität hat, braucht einen intelligenten Review-Prozess. Weil bei unserem internat…