Hopp til innhold

Schreiben Sie eine Benutzeranleitung

Relevante sider
Andre relevante sider
Skip to content

Dies ist ein maschinell übersetzter Text und kann Fehler enthalten!

Eine Benutzeranleitung schreiben

Kurz zusammengefasst
  • Ein Benutzerhandbuch hilft einer bestimmten Person bei der Ausführung einer bestimmten Aufgabe.
  • Jeder Schritt enthält eine Aktion und gibt an, was die Nutzerin oder der Nutzer danach sehen sollte.
  • Die Anleitung ist erst abgeschlossen, wenn jemand, der das System nicht kennt, sie befolgt hat.

Wer soll sie verwenden?

Fragen Sie immer zuerst: Wer soll die Anleitung verwenden und was sollen die Anwender nach Abschluss erreicht haben?

Ein neuer IT-Mitarbeiter, der mit dem Terminal umgehen kann, benötigt eine andere Anleitung als ein Lehrer, der es noch nie geöffnet hat. Dasselbe System kann daher mehrere Anleitungen benötigen. Ermitteln Sie, über welches Vorwissen der Empfänger verfügt, auf welche Ressourcen er Zugang hat und welche Begriffe ihm unbekannt sind.

Welche Art von Dokument ist es?

Ein Benutzerhandbuch ist eine Handlungsanleitung: Es hilft dem Nutzer bei der Ausführung einer einzelnen Aufgabe. Es handelt sich nicht um ein Lehrbuch, Nachschlagewerk oder eine Erklärung dafür, warum das System so funktioniert, wie es tut.

Dokumenttyp Frage des Lesers Beispiel
Handlungsanleitung Wie mache ich das? So veröffentlichen Sie eine neue Version der App
Schulung Wie lerne ich das? Ihr erster Container, Schritt für Schritt
Referenz Was ist der Wert oder die Kommandozeile? Liste über Ports und Dienste
Erläuterung Warum funktioniert es so? Warum wir einen Reverse Proxy verwenden

Braucht der Nutzer unterwegs eine Erklärung, halten Sie sie kurz und fügen Sie sie dort hinzu, wo der Nutzer sie benötigt.

Die Abschnitte in der Anleitung

Abschnitt Was sie beantwortet
Ziele Was hat die Nutzerin/das Nutzer erreicht, wenn die Anleitung befolgt wurde?
Vor dem Start Welche Zugänge, Programme, Dateien und Vorkenntnisse werden benötigt?
Schritt für Schritt Was tut die Nutzerin/der Nutzer, in welcher Reihenfolge und was sollte jede/r nach jedem Schritt sehen?
Beispiele Wie sieht ein Befehl, eine Einstellung oder ein korrektes Ergebnis aus?
Fehlerbehebung Was tut die Nutzerin/der Nutzer, wenn das Ergebnis nicht wie erwartet ist?
Falls Sie rückgängig machen müssen Wie wird eine fehlerhafte Änderung zurückgesetzt?
Checkliste Wie überprüft die Nutzerin/der Nutzer am Ende, ob alles korrekt ist?
Wichtige Tipps Was haben Sie gelernt, was die Nutzerin/der Nutzer wissen sollte?
Quellen und Kontrolle Auf welchen Quellen, welcher Version und welchem Testumfeld basiert die Anleitung?

So schreiben Sie einen Schritt

Die Regeln basieren auf Standards für Handbücher und Benutzerdokumentation (IEC/IEEE 82079-1 und ISO/IEC/IEEE 26514).

  • Beginnen Sie jeden Schritt mit einem Verb im Imperativ: „Öffnen“, „Ausführen“, „Prüfen“.
  • Verwenden Sie eine Aktion pro Schritt und eine Anweisung pro Satz. Halten Sie die Sätze auf etwa 20 Wörter oder weniger beschränkt.
  • Beschreiben Sie, was der Benutzer sehen soll, wenn der Schritt abgeschlossen ist.
  • Platzieren Sie Warnungen vor dem jeweiligen Schritt, nicht danach.
  • Verwenden Sie durchgehend dieselben Begriffe für dasselbe Objekt. Wenn an einer Stelle von „der Konsole“ die Rede ist, sollte es anderswo nicht „das Terminal“ heißen.
  • Erklären Sie Fachbegriffe bei ihrer ersten Verwendung.

Schwacher Schritt:

Richte die Website ein und überprüft Sie, ob alles funktioniert.
Besserer Schritt:

3. Konfiguration prüfen

Führen Sie Folgendes aus:

sudo nginx -t

Sie sollten sehen:

nginx: configuration file /etc/nginx/nginx.conf test is successful

Wenn Sie etwas anderes sehen, gehen Sie zu „Fehlerbehebung“.

Befehl, erwartetes Ergebnis und Platzhalter

  • Geben Sie Befehle in einem Codeblock ein und das erwartete Ergebnis in einem separaten Block darunter.
  • Verwenden Sie die Code-Schreibweise für Dateinamen, Pfade und Befehle im Fließtext, z. B. /etc/nginx/.
  • Schreiben Sie niemals echte Passwörter, Schlüssel oder interne Adressen. Verwenden Sie eindeutige Platzhalter: <server-ip>, <benutzername>, <domain>.
  • Halten Sie Zeilen unter etwa 70 Zeichen, damit sie auf Papier nicht abgeschnitten werden.

Fehlerbehebung

Konzipieren Sie die Fehlersuche um das herum, was der Benutzer sieht:

Symptom → mögliche Ursachen → Untersuchung → Lösung → Verifizierung
Symptom Mögliche Ursache Untersuchung Lösung So sehen Sie, dass es gelöst ist
Die Website zeigt „502 Bad Gateway“ an Der dahinterliegende Dienst antwortet nicht Führen Sie docker compose ps aus und prüfen Sie, ob der Container läuft Starten Sie den Container mit docker compose up -d Die Seite wird geladen und docker compose ps zeigt in der Spalte STATUS „Up“ an

Die zugrunde liegende Methode steht in [[Fehlersuchmethode Ebene 1 - Systematische Fehlersuche|Fehlersuchmethode]].

Screenshots

Verwende ein Screenshot nur dann, wenn er dem Benutzer hilft, ein korrektes Ergebnis wiederzuerkennen. Schneiden Sie das Bild zu, markieren Sie den wichtigsten Bereich mit einem Pfeil oder einer Zahl und entfernen Sie sensible Informationen. Schreiben Sie einen alternativen Text, der beschreibt, was das Bild zeigt.

  • Windows: Windows-Taste + Umschalt + S
  • Mac: Strg + Umschalt + 4
![Der Nginx Proxy Manager zeigt den Proxy-Host mit dem Status "Online" an](bilder/proxy-online.png)

Als PDF exportieren

  1. Öffnen Sie die Anleitung im Vorschau-Modus in VS Code oder öffnen Sie die Datei auf GitHub.
  2. Wählen Sie Drucken aus. Windows: Strg + P. Mac: Befehl + P.
  3. Wählen Sie „Als PDF speichern“.
  4. Blättern Sie durch das PDF-Dokument. Stellen Sie sicher, dass keine Zeilen von Codezeilen, Tabellen oder Bildern abgeschnitten werden.

Feedback einholen, bevor die Abgabe erfolgt

Lassen Sie einen Mitschüler die Anleitung lesen, bevor Sie sagen, dass sie fertig ist. Die Person, die das Feedback gibt, antwortet kurz und verweist auf den entsprechenden Stellen im Text:

  1. Korrektheit: Gibt es Schritte oder Aussagen, an denen Sie Zweifel haben?
  2. Zielgruppe und Struktur: Ist klar, für wen die Anleitung gedacht ist und was zuerst erledigt werden muss?
  3. Sprache und Handlung: Enthält jeder Schritt eine einzige Handlung und ein erwartetes Ergebnis? Sind Fachbegriffe erklärt?
  4. Sicherheit: Steht dort etwas, das nicht veröffentlicht hätte werden sollen?

Nennen Sie zwei Stärken und zwei konkrete Verbesserungsvorschläge. Seien Sie freundlich und konkret: „Ich schlage vor, proxy in Schritt 2 zu erklären, weil …“ hilft mehr als „unklar“. Mehr zum Thema Feedback geben: NDLA Wie gibt man Rückmeldungen?.

Aufgabe 1 – Mache schwache Schritte besser

Formuliere jeden Schritt so um, dass er ein Verb im Imperativ, eine Handlung und ein erwartetes Ergebnis enthält. Zerlege Schritte, die mehrere Handlungen enthalten.

  1. „Jetzt muss der Container gestartet werden und es sollte überprüft werden, ob er läuft.“
  2. „Ändere die Konfiguration, vergiss nicht, sie danach zu testen und lade sie anschließend neu ein.“
  3. „Melde dich mit dem Passwort Sommer2026! auf dem Server an und gehe in den Ordner mit der Website.“

Aufgabe 2 – Schreibe eine kurze Anleitung

Wähle eine Aufgabe aus, die du ohne Hilfe erledigen kannst, zum Beispiel das Starten eines Containers oder das Veröffentlichen einer Änderung auf einer Website.

  1. Beschreibe, für wen die Anleitung gedacht ist und was sie danach können sollen.
  2. Schreibe drei bis sechs Schritte mit dem erwarteten Ergebnis.
  3. Füge mindestens eine Zeile zur Fehlerbehebung hinzu.
  4. Lass einen Mitschüler der Anleitung folgen, während du nichts erklärst. Korrigiere an den Stellen, an denen er feststeckt.

Weitere Lektüre