Deutsch

How to do: „Überblick“

Über den Nutzen eines Überblickskapitels

CREATE
How to do: „Überblick“

Uns ist wohl allen bewusst, dass wir keine packenden Krimis schreiben. In einer Dokumentation einen Spannungsbogen aufzubauen und so das Interesse des Lesers aufrechtzuhalten, ist eine Challenge für sich. Unsere beste Chance, das Interesse des Nutzers zu wecken, ist ein interessantes Überblickskapitel. Das Überblickskapitel ist das Erste, was er sieht, wenn er unsere Anleitung aufschlägt. Es ist unsere Chance, den Nutzer davon zu überzeugen, dass sich ein Blick in das Informationsprodukt lohnen kann, dass wir ihm helfen wollen und dass er in dem Dokument einfach verständliche Informationen findet. Wie schaffen wir das? Wir müssen dem Nutzer genau die Informationen geben, die ihn interessieren.

Was der Nutzer wissen will

Keiner will einer Flut von Warnhinweisen entgegensehen, die den Anschein erweckt, einen Fehlkauf getätigt zu haben. Wer will denn schon auf 10 Seiten lesen, was alles beim Gebrauch des Produkts zu beachten ist, wenn das Produkt noch gar nicht in Gebrauch ist? Wahrscheinlich will der Nutzer auch noch nicht die Funktion jeder Schraube und Schaltfläche wissen. Muss der Nutzer sich dieses Wissen erst aneignen, würde es zu lange dauern, bis er endlich das Produkt in Betrieb nehmen kann. Und hier sind wir auch bereits beim springenden Punkt: Wir dürfen davon ausgehen, dass der Leser das Produkt schnellstmöglich nutzen möchte.

Im Überblickskapitel können wir ihm also zum Beispiel sagen, wie er das Produkt nutzen kann, wie es funktioniert, was er für Voraussetzungen erfüllen muss, wo er welche Informationen findet und was er über das Produkt wissen muss, um es möglichst bald nutzen zu können.

Ein Kapitel mit Mehrwert

Wir verwenden Übersichtszeichnungen und Infografiken, um das Funktionsprinzip vereinfacht zu illustrieren. Dabei ist es aber wichtig, nicht nur das Offensichtliche zu sagen: Der Nutzer soll auf jeder Seite etwas lernen können. Bei Übersichtszeichnungen will ich demnach nicht nur sagen, dass sich der Antrieb an Position X befindet, sondern auch, dass sich in Kapitel Y Informationen zum Antrieb befinden oder dass der Antrieb gereinigt werden muss und dies im Kapitel Z beschrieben wird.

Gibt es Schnittstellen an dem Produkt? Welche Informationen braucht der Nutzer, um es in ein Gesamtsystem einzubinden, und wo findet er Informationen dazu? Gibt es vielleicht noch weitere Dokumente zu beachten, wie zum Beispiel Reinigungspläne oder Wartungsanleitungen? Bei Herstellerdokumentationen von Komponenten kann es hilfreich sein, zu wissen, welche Informationen sich in der Herstellerdokumentation und welche in der vorliegenden Dokumentation befinden.

Im Überblickskapitel stelle ich gerne auch die wichtigste Schnittstelle kurz vor: die zwischen Nutzer und Produkt. Welche Bedienelemente gibt es, wie ist die Benutzeroberfläche aufgebaut? Gibt es Konventionen, die dem Nutzer helfen, die Benutzeroberfläche zu verstehen? Die Darstellung von Schaltflächen oder Statusanzeigen, die Inhalte der Kopfzeile oder die Logik des Menüaufbaus zu erklären, kann viele Fragen vorwegnehmen.

Solange der Nutzer einen Mehrwert hat, darf das Überblickskapitel auch einmal ein Zehntel der Gesamtseitenzahl beanspruchen. Es soll dem Nutzer helfen, sich mit dem Produkt und der Anleitung vertraut zu machen.

Team Redaktion
Autor:
Blog post Team Redaktion