Benutzerdokumentation und Schulungsunterlagen erstellen

Eine gute Dokumentation beginnt nicht beim Schreiben, sondern bei der Frage: Wer liest das, in welcher Situation, und was will die Person erreichen? In diesem Modul wählst du für eine Zielgruppe die passende Form, von der einseitigen Kurzanleitung bis zum Erklärvideo. Du schreibst handlungsorientierte Anleitungen mit klaren Schritten und aussagekräftigen Screenshots und legst sie auffindbar und versioniert ab. Danach planst du eine Schulung mit Lernzielen, Übungen und Unterlagen und prüfst mit Testpersonen und Feedback, ob beides funktioniert.

Das sind die Fähigkeiten, die am Ende des Moduls sitzen sollten. Jedes Ziel mit einem Beispiel aus dem Lehrbetrieb.

1. 1

   Zielgruppe und Nutzungssituation analysieren und die passende Dokumentationsform wählen

   Kompetenz A

   Du klärst, wer die Doku nutzt, was diese Personen schon können und wann sie nachschauen: am Schreibtisch, unterwegs auf dem Handy oder nur einmal im Jahr. Danach entscheidest du dich für Handbuch, Kurzanleitung, Quick Reference Card, FAQ, Video oder eine Kombination.

   Situation

   Eine Spitex-Organisation im Zürcher Oberland führt eine Tablet-App zur Leistungserfassung ein. Die 90 Pflegenden sind zwischen 20 und 63 Jahre alt, viele erfassen unterwegs im Auto zwischen zwei Einsätzen.

   Deine Aufgabe

   Analysiere die Zielgruppe und wähle die Dokumentationsformen.

   Gutes Ergebnis

   Persona 'Ruth, 58, Pflegefachfrau, nutzt das Handy vor allem für WhatsApp'. Entscheid: laminierte Karte mit den 6 häufigsten Handgriffen fürs Auto, 2-minütige Videos pro Aufgabe über QR-Code, FAQ im Intranet. Kein langes Handbuch, weil es unterwegs niemand liest.

   ZielgruppenanalysePersonaNutzungssituationDokumentationsartQuick Reference Card
2. 2

   Handlungsorientierte Anleitungen schreiben, die man beim Arbeiten befolgen kann

   Kompetenz B

   Jede Anleitung löst eine konkrete Aufgabe. Du nennst Ziel und Voraussetzungen, schreibst nummerierte Schritte mit einer Handlung pro Schritt in der Befehlsform und beschreibst, woran man merkt, dass es geklappt hat. Fachbegriffe übernimmst du genau so, wie sie in der Software stehen.

   Situation

   Im Architekturbüro deines Lehrbetriebs werden Spesen neu im ERP Abacus erfasst. Die bisherige Anleitung ist ein Fliesstext über zwei Seiten.

   Deine Aufgabe

   Schreibe die Anleitung 'Spesen mit Beleg erfassen' neu.

   Gutes Ergebnis

   Titel als Aufgabe, Abschnitt 'Das brauchst du' (Foto des Belegs, Projektnummer), 8 nummerierte Schritte wie '3. Tippe auf Beleg hinzufügen und fotografiere die Quittung.', Hinweis zu Belegen über CHF 300, Schlusssatz 'Der Status zeigt jetzt In Prüfung.' Länge: eine Seite.

   HandlungsanweisungMinimalismusBefehlsformVoraussetzungErgebnisbeschreibung
3. 3

   Screenshots, Markierungen und kurze Videos gezielt einsetzen

   Kompetenz C

   Bilder zeigen, wo etwas ist, Text erklärt, was zu tun ist. Du schneidest Screenshots auf den relevanten Ausschnitt zu, markierst die Klickstelle und nummerierst passend zu den Schritten. Personendaten auf Screenshots ersetzt du durch Testdaten. Für Abläufe mit vielen Klicks drehst du ein Video von höchstens drei Minuten.

   Situation

   Die Spesenanleitung enthält Vollbild-Screenshots, auf denen echte Namen und Kontonummern von Mitarbeitenden zu sehen sind.

   Deine Aufgabe

   Überarbeite die Bilder und ergänze ein Video.

   Gutes Ergebnis

   Screenshots aus der Testumgebung mit Testperson 'Muster Anna', auf den Arbeitsbereich zugeschnitten, rote Rahmen und Nummern passend zu den Schritten. Dazu ein Clipchamp-Video von 2:10 Minuten mit Untertiteln, auf Stream abgelegt und in der Anleitung verlinkt.

   Screenshot-BearbeitungMarkierungErklärvideoTestdatenUntertitel
4. 4

   Dokumentation strukturieren, versionieren und auffindbar ablegen

   Kompetenz D

   Du gliederst die Dokumentation nach Aufgaben statt nach Menüpunkten, nutzt Formatvorlagen und ein Inhaltsverzeichnis und legst sie an einem bekannten Ort ab. Jedes Dokument hat Version, Datum und eine verantwortliche Person, damit es nach einem Software-Update aktualisiert wird.

   Situation

   In einem Getränkehandel in Burgdorf liegen 35 Anleitungen verstreut auf einem Netzlaufwerk, im Mailordner und ausgedruckt im Lager. Niemand weiss, welche aktuell ist.

   Deine Aufgabe

   Baue eine auffindbare Wissensablage auf.

   Gutes Ergebnis

   SharePoint-Seite 'So geht's' mit Kategorien Verkauf, Lager, Buchhaltung, Suche über Stichworte. Jede Anleitung mit Kopfzeile 'Version 1.3, 12.03., verantwortlich: Lager-Key-User'. 9 veraltete Dokumente gelöscht, 4 zusammengeführt. Ein Halbjahrestermin zur Überprüfung im Kalender.

   GliederungFormatvorlageVersionierungWissensdatenbankDokumentverantwortung
5. 5

   Ein Schulungskonzept mit Lernzielen, Ablauf und Methoden erstellen

   Kompetenz E

   Du formulierst, was die Teilnehmenden nach der Schulung können sollen, und planst den Ablauf in Sequenzen mit Zeit, Inhalt, Methode und Material. Du wechselst zwischen kurzer Demo und eigener Übung ab und planst Raum, Geräte und Schulungsumgebung.

   Situation

   Ein Personalvermittler in Bern führt Dynamics 365 Sales ein. 16 Beraterinnen und Berater sollen in einer Halbtagesschulung fit gemacht werden.

   Deine Aufgabe

   Erstelle das Schulungskonzept.

   Gutes Ergebnis

   Lernziele wie 'Die Teilnehmenden erfassen eine neue Verkaufschance mit allen Pflichtfeldern in unter 3 Minuten.' Ablauf in 6 Sequenzen über 3,5 Std. mit 20 % Demo und 60 % Übung. Zwei Gruppen à 8 Personen, Schulungsumgebung mit Testdaten, Key User als Co-Trainerin.

   LernzielSequenzplanungMethodenwechselSchulungsumgebungZeitplan
6. 6

   Übungsaufgaben und Schulungsunterlagen für Teilnehmende und Trainer erstellen

   Kompetenz E

   Teilnehmende brauchen realistische Übungsfälle mit vorbereiteten Daten und eine Unterlage, die sie danach am Arbeitsplatz nutzen können. Für die Trainerin erstellst du einen Leitfaden mit Ablauf, Lösungen und typischen Fragen.

   Situation

   Für die Dynamics-Schulung fehlen noch Übungen. Die Beraterinnen sollen echte Situationen aus ihrem Alltag durchspielen.

   Deine Aufgabe

   Erstelle drei Übungsfälle und die Unterlagen.

   Gutes Ergebnis

   Übung 1: Anfrage einer Zuger Treuhandfirma für eine Buchhalterin als Verkaufschance erfassen. Übung 2: Chance nach Gespräch auf Phase 'Offerte' setzen und Aufgabe 'Nachfassen' anlegen. Übung 3: Eigene Pipeline filtern. Teilnehmerunterlage mit Lösungsweg zum Nachschlagen, Trainerleitfaden mit Zeitangaben und den 5 häufigsten Fragen.

   ÜbungsfallTestdatenTeilnehmerunterlageTrainerleitfadenTransfer
7. 7

   Dokumentation und Schulung mit Testpersonen und Feedback überprüfen

   Kompetenz F

   Du lässt eine Person aus der Zielgruppe die Anleitung ohne deine Hilfe ausführen und beobachtest, wo sie stockt. Nach Schulungen holst du Feedback ein und prüfst, ob die Lernziele erreicht wurden. Supportanfragen nach der Einführung zeigen dir, wo die Doku noch Lücken hat.

   Situation

   Die Spitex-Kurzkarte ist fertig. Vor dem Druck von 120 Exemplaren soll sie geprüft werden.

   Deine Aufgabe

   Teste die Karte mit der Zielgruppe und werte das Ergebnis aus.

   Gutes Ergebnis

   Drei Pflegende führen je 3 Aufgaben nur mit der Karte aus. Zwei suchen den Button 'Leistung abschliessen' unter 'Speichern'. Begriff auf der Karte angepasst und Screenshot ergänzt. Nach der Schulung Forms-Umfrage: 4,4 von 5 Punkten, aber 30 % wünschen mehr Übungszeit. In den ersten 4 Wochen 18 Supportanfragen, davon 7 zum Thema Wegzeiten, dafür neues FAQ erstellt.

   NutzertestBeobachtungFeedbackbogenLernerfolgskontrolleSupportanalyse

Die Kompetenzmatrix zerlegt das Modul in Themenstränge und drei Stufen. Für den Kompetenznachweis solltest du überall mindestens Stufe 2 erreichen. Dein Stand bleibt in diesem Browser gespeichert und färbt Lernweg und Übungen ein.

Gian ist Entwickler digitales Business im 3. Lehrjahr beim Hotel Bergkristall in Davos mit 85 Mitarbeitenden. Ab Dezember meldet das Housekeeping den Zimmerstatus nicht mehr auf Zetteln, sondern mit einer App auf dem Smartphone. Gian erstellt die Anleitungen und schult die Teams vor dem Saisonstart.

1. Kapitel 1

   Wer putzt, liest keine Handbücher

   Gian begleitet das Housekeeping einen Morgen lang. Von den 22 Mitarbeitenden sprechen viele vor allem Portugiesisch oder Spanisch, arbeiten unter Zeitdruck und tragen Handschuhe. Für sie plant er eine laminierte Kurzkarte mit Symbolen und einem QR-Code zu Videos von 60 Sekunden. Die zwei Gouvernanten erhalten eine ausführliche Anleitung, die Rezeption ein kurzes FAQ.

   Ziel 1

2. Kapitel 2

   Ein Schritt, ein Bild

   Die erste Version der Anleitung umfasst drei Seiten Fliesstext. Gian schreibt sie in sechs Schritte mit je einer Handlung um, zum Beispiel '3. Tippe auf Zimmer gereinigt'. Auf seinen ersten Screenshots sind echte Gästenamen zu sehen, deshalb wiederholt er die Aufnahmen in der Testumgebung mit erfundenen Namen. Die Videos nimmt er als Bildschirmaufnahme ohne Ton auf und ergänzt Untertitel auf Deutsch und Portugiesisch.

   Ziel 2Ziel 3

3. Kapitel 3

   Wo ist die aktuelle Version?

   Gian legt alle Unterlagen in SharePoint auf einer Seite 'Housekeeping-App' ab, jede Datei mit Version und Änderungsdatum. Der QR-Code auf der Kurzkarte zeigt auf die Seite statt auf eine einzelne Datei, damit er auch nach einem Update noch stimmt. Eine Gouvernante wird als verantwortliche Person eingetragen. Vor jedem Saisonstart prüft sie, ob die Anleitungen noch zur aktuellen App-Version passen.

   Ziel 4

4. Kapitel 4

   45 Minuten vor der Schicht

   Gian plant drei Schulungen zu je 45 Minuten für Gruppen von acht Personen. Das Lernziel lautet: 'Nach der Schulung meldest du ein Zimmer selbstständig als gereinigt, gesperrt oder mit Schaden.' Nach zehn Minuten Vorzeigen üben die Teilnehmenden 25 Minuten lang in vier Testzimmern mit Übungskarten wie 'In Zimmer 214 ist die Leselampe defekt'. Für die Gouvernante, die später neue Mitarbeitende einführt, schreibt er einen Trainerleitfaden mit Musterlösungen.

   Ziel 5Ziel 6

5. Kapitel 5

   Was die Testpersonen zeigen

   Vor dem Druck testet Gian die Kurzkarte mit drei Mitarbeitenden. Zwei finden die Funktion 'Schaden melden' nicht, weil das Symbol unklar ist, also ersetzt er es durch ein Werkzeug-Symbol. Nach den Schulungen fühlen sich 19 von 22 Personen laut einer kurzen Smiley-Umfrage sicher. Zwei Wochen nach dem Start sind die Rückfragen an der Rezeption von 15 auf 3 pro Tag gesunken.

   Ziel 7

1. 1

   Für wen schreibst du?

   ca. 3 Std.

   Du lernst, Zielgruppen und Nutzungssituationen zu analysieren und daraus die Dokumentationsform abzuleiten.

   • Drei Anleitungen aus deinem Alltag (Gerät, App, Lehrbetrieb) nach Zielgruppe und Wirkung bewerten
   • Für eine Software im Lehrbetrieb zwei Personas erstellen
   • Für jede Persona die passende Dokumentationsform begründen

   Trainiert Kompetenz A1A2

   Lernziel1

2. 2

   Anleitungen schreiben und bebildern

   ca. 5 Std.

   Du schreibst Anleitungen nach den Regeln des technischen Schreibens und ergänzt sie mit sauberen Screenshots.

   • Eine bestehende Fliesstext-Anleitung in nummerierte Schritte umschreiben
   • Screenshots mit Snagit oder Greenshot zuschneiden, markieren und anonymisieren
   • Ein Erklärvideo von maximal 3 Minuten aufnehmen und mit Untertiteln versehen

   Trainiert Kompetenz B1B2C1C2

   Lernziel23

3. 3

   Ordnung schaffen

   ca. 3 Std.

   Du baust eine Struktur für mehrere Anleitungen auf und legst sie versioniert und auffindbar ab.

   • Ein Inhaltsverzeichnis nach Aufgaben statt Menüpunkten entwerfen
   • Eine Word-Vorlage mit Formatvorlagen und Kopfzeile für Version und Verantwortung erstellen
   • Eine SharePoint-Seite oder Wiki-Struktur für die Ablage einrichten

   Trainiert Kompetenz D1D2

   Lernziel4

4. 4

   Eine Schulung planen

   ca. 3 Std.

   Du formulierst Lernziele und baust daraus einen Schulungsablauf mit Methodenwechsel.

   • Für eine Software 4 bis 6 überprüfbare Lernziele formulieren
   • Einen Sequenzplan mit Zeit, Inhalt, Methode und Material erstellen
   • Organisatorisches planen: Raum, Geräte, Schulungsumgebung, Testkonten

   Trainiert Kompetenz E1E2

   Lernziel5

5. 5

   Unterlagen und Übungen

   ca. 3 Std.

   Du erstellst realistische Übungsfälle, eine Teilnehmerunterlage und einen Trainerleitfaden.

   • Drei Übungsfälle mit vorbereiteten Testdaten erstellen
   • Eine Teilnehmerunterlage zum Nachschlagen nach der Schulung gestalten
   • Einen Trainerleitfaden mit Lösungen und typischen Fragen schreiben

   Trainiert Kompetenz E2E3

   Lernziel6

6. 6

   Testen, schulen, verbessern

   ca. 4 Std.

   Du testest deine Unterlagen mit echten Personen, führst eine Mini-Schulung durch und verbesserst alles anhand des Feedbacks. So sieht auch der Kompetenznachweis aus.

   • Eine Anleitung mit einer Testperson ohne deine Hilfe ausprobieren lassen und Stolperstellen notieren
   • Eine 30-minütige Schulungssequenz mit Kolleginnen durchführen
   • Feedback mit Microsoft Forms auswerten und Unterlagen überarbeiten

   Trainiert Kompetenz B3F1F2F3

   Lernziel762

Benutzerdokumentation

Alle Unterlagen, die Nutzenden helfen, eine Software für ihre Aufgaben zu bedienen.

Quick Reference Card

Kurzübersicht auf einer Seite mit den wichtigsten Handgriffen.

Handlungsorientierung

Prinzip, Dokumentation nach den Aufgaben der Nutzenden statt nach den Funktionen der Software aufzubauen.

Persona

Fiktive, aber typische Person einer Zielgruppe mit Eigenschaften, Zielen und Gewohnheiten.

Formatvorlage

Gespeicherte Formatierung in Word für Überschriften und Text, die einheitliche Gestaltung und automatische Verzeichnisse ermöglicht.

Lernziel

Beschreibung dessen, was Teilnehmende nach der Schulung beobachtbar können sollen.

Sequenzplan

Ablaufplan einer Schulung mit Zeit, Inhalt, Methode und Material pro Abschnitt.

Trainerleitfaden

Unterlage für die schulende Person mit Ablauf, Lösungen und Hinweisen.

Nutzertest

Prüfung, bei der Personen aus der Zielgruppe eine Aufgabe ausführen und dabei beobachtet werden.

Passende Module