Kurzanleitung (Quick Reference Guide): ein echtes Beispiel auf einer Seite und die Vorlage dazu

Die kurze Antwort

Eine Kurzanleitung ist eine einzige Seite für jemanden, der die Arbeit schon kennt. Jede Zeile nennt eine Aufgabe, sagt, wo sie liegt und was zu klicken ist, und ergänzt die eine Warnung, auf die es ankommt. Man schlägt in zehn Sekunden nach und arbeitet weiter.

Die Seiten, die für den Begriff oben stehen, sind sich einig, dass es kurz sein muss, und uneins, wie kurz. Ein Gastbeitrag im Blog von MadCap Software, geschrieben von Logan Mazza, Senior Technical Writer bei Veeva Systems, beschreibt Kurzanleitungen als „short, easy to read documents that distill complex instructions into simple, fundamental steps“. Für TechSmith ist es „a condensed set of instructions on how to use a product“, „no longer than two pages“. Whatfix definiert sie als „a short technical document (usually less than 5 pages)“. Dieser Ratgeber nimmt die strenge Lesart: eine Seite A4. Eine zweite Seite ist ein zweites Dokument.

Andere Namen dafür: Kurzreferenz, Spickzettel, Quick Reference Card (QRC), Cheat Sheet, Kurzübersicht, One-Pager.

Softwarehersteller geben dasselbe Format ihren Kunden mit: eine Seite mit den meistgenutzten Funktionen eines Produkts. Die Regeln unten gelten für beide.

Eine echte Kurzanleitung

Die Seite unten ist die Kurzanleitung des Finanzteams bei Northwind, einem erfundenen Onlineshop. Das Team arbeitet mit drei Web-Tools: Paynest für Kartenzahlungen, Ledgerly für Rechnungen und Cartwell für Bestellungen. Die Seite enthält sieben Aufgaben, die jeden Monat anfallen und dazwischen vergessen werden. Jeder Screenshot ist aus einer echten Aufnahme der Aufgabe in diesen Tools zugeschnitten, denselben Aufnahmen hinter den fertigen Anweisungen in SOP-Beispiele. Die Oberflächen der Tools sind englisch, deshalb stehen die Beschriftungen auf Englisch.

Jede Zeile hat dieselben vier Teile:

• Aufgabe, mit Verb: „Bezahlte Bestellung erstatten“, nicht „Erstattungen“.
• Klickpfad in Worten, mit den genauen Beschriftungen in Fett: Bestelldetails > Actions > Issue refund > Refund note > Save refund.
• Eine Grenze, nur wo ein Fehler Geld oder Daten kostet: „Bis 200 EUR ohne Freigabe; darüber erst, wenn die Finanzleitung im Ticket freigegeben hat. Eine gespeicherte Erstattung lässt sich nicht zurücknehmen.“
• Ein zugeschnittener Screenshot des Bedienelements, mit seiner Markierung.

Wie alles auf eine Seite passt

Layoutregeln, damit es bei einer Seite bleibt

Diesen Regeln folgt das Beispiel. Es sind Arbeitsregeln aus dem Bau solcher Seiten, keine Forschungsergebnisse; die Zahlen ändern, wenn ein Ausdruck etwas anderes zeigt.

• 6 bis 12 Aufgaben. Mehr heißt: zwei Kurzanleitungen, nach Rolle oder Tool getrennt, nicht eine kleinere Schrift.
• Zeilen nach Tool und Bildschirm gruppieren, in der Reihenfolge des Menüs, damit man einen Block überfliegt und nicht die ganze Seite.
• Jeden Screenshot auf das Bedienelement plus einen Nachbarn zuschneiden. Eine Markierung pro Ausschnitt. Keine ganzen Bildschirme.
• Den Pfad neben jedem Ausschnitt in Worten schreiben, damit die Seite auch schwarz-weiß gedruckt funktioniert oder wenn sich die Farben am Bildschirm ändern.
• Fließtext nicht kleiner als 9 pt. Einmal bei 100 % drucken und auf Armlänge lesen.
• Fußzeile: Version des Tools, Prüfdatum, Verantwortliche Person, und wo die vollständigen Anweisungen liegen.

Zuschneiden, Markieren und Weichzeichnen erklärt Screenshots für Anleitungen im Detail.

Eine Kurzanleitung erstellen

1. Aufgaben sammeln. Nehmen, was die Rolle wöchentlich oder monatlich erledigt und wonach gefragt wird. Behalten, was oft genug vorkommt, um zu zählen, und teuer genug ist, wenn es schiefgeht.
2. Jede Aufgabe einmal durchspielen und die Klicks aufnehmen. Die Screenshots stammen aus diesem Durchlauf, nicht aus dem Gedächtnis.
3. Jeden Screenshot zuschneiden und markieren auf das Bedienelement, und Kundennamen, E-Mail-Adressen und nicht benötigte Beträge weichzeichnen.
4. Jede Zeile schreiben: Aufgabe mit Verb, der Pfad mit den genauen Beschriftungen, eine Grenze.
5. In die Vorlage setzen, ausdrucken und jemandem geben, der die Arbeit kennt, die Seite aber noch nicht gesehen hat. Jede Rückfrage ist eine Zeile, die nachgebessert werden muss.
6. Datum eintragen und prüfen, sobald eines der Tools seine Bildschirme ändert.

Eine Kurzanleitung setzt voraus, dass die Aufgaben schon aufgeschrieben und geschult sind. Wenn nicht, zuerst eine SOP schreiben, also die vollständige Anweisung; der Ratgeber dazu zeigt es an einem Beispiel.

Vorlage für die Kurzanleitung

Die Vorlage ist eine A4-Seite: eine Titelzeile mit Tool und Rolle, eine Zeile dazu, für wen sie ist und wo die vollständigen Anweisungen liegen, ein Aufgabenraster aus drei Gruppen mit je drei Zeilen (Aufgabe, Pfad und Hinweis, Platz für den Screenshot) und eine Fußzeile für Version des Tools, Prüfdatum und Verantwortliche. Das ausgefüllte Beispiel ist die Northwind-Seite oben.

Jeden Text in [Klammern] ersetzen und nicht benötigte Zeilen löschen. Die Gruppenzeilen nach den Tools und Bildschirmen benennen, mit denen die Rolle arbeitet. Die Markdown-Dateien enthalten nur den Text; die Screenshots des ausgefüllten Beispiels stecken in den Fassungen als Word, OpenDocument und PDF.

In Word einen Ausschnitt in seine Zelle einfügen und dann unter Bildformat > Größe seine Breite festlegen, damit ein großer Screenshot die Spalte nicht verbreitert und die Seite auf ein zweites Blatt schiebt. Alle Ausschnitte im selben Maßstab einsetzen, dann sind die Beschriftungen in jeder Zeile gleich groß.

Kurzanleitung, Benutzerhandbuch und Job Aid im Vergleich

Der Unterschied zum Job Aid ist Breite gegen Tiefe: Ein Job Aid führt Schritt für Schritt durch eine Aufgabe, eine Kurzanleitung hat eine Zeile pro Aufgabe. Was ein Job Aid ist und wann es reicht, steht unter Job Aid. Das Benutzerhandbuch ist das andere Ende: Es wird gelesen, um das Produkt zu lernen, und beschreibt auch Funktionen, die in der Rolle niemand nutzt.

Was zuerst schreiben: die Anweisung. Eine Kurzanleitung braucht Aufgaben, die bekannt und abgestimmt sind; ohne das verbreitet sie nur die Gewohnheiten einer Person. Wo die Kurzanleitung unter den anderen Prozessdokumenten steht, zeigt Verfahrensanweisung und Prozess.

Quellen