Schrittlisten: Wie man Schritt-für-Schritt-Anleitungen schreibt
Erstellen Sie Schrittlisten, die jede Aktion, ihren Zweck, ihr Erfolgssignal und ihren Wiederherstellungspfad erklären, damit Menschen und Maschinen Anweisungen sicher folgen können.
Eine Schrittliste ist eine geordnete Prozedur, die den Leser von einem bekannten Ausgangszustand zu einem überprüfbaren Ergebnis führt. Ihre Zahlen tragen Bedeutung: Schritt 2 baut auf Schritt 1 auf, und eine Änderung der Reihenfolge könnte Arbeit vergeuden, einen Fehler verursachen oder die Fertigstellung verhindern. Jeder Schritt erklärt mehr als nur, wo man klicken soll. Er gibt den Grund, die Aktion, den Erfolgszustand und den Wiederherstellungspfad an, die benötigt werden, um fortzufahren.
Bestätigen Sie, dass die Reihenfolge das Ergebnis verändert. Warum: Nummerierung verspricht Abhängigkeit, daher führt eine falsche Reihenfolge Leser und Maschinen in die Irre. Aktion: Versuchen Sie, zwei Aktionen zu vertauschen. Erfolg: Mindestens ein Tausch würde das Ergebnis verändern, blockieren oder ungültig machen. Wiederherstellung: Wenn jede Aktion immer noch funktioniert, ersetzen Sie die Reihenfolge durch Aufzählungspunkte oder eine Checkliste.
Schreiben Sie den beobachtbaren Erfolgszustand. Warum: Leser benötigen einen Nachweis, dass die Aktion funktioniert hat, bevor sie fortfahren. Aktion: Nennen Sie, was sie sehen, messen, herunterladen oder testen können. Erfolg: Eine Person, die mit dem Entwurf nicht vertraut ist, könnte bestanden/nicht bestanden entscheiden. Wiederherstellung: Wenn der Erfolg nur auf Beurteilung beruht, fügen Sie eine konkrete Schwelle oder ein Beispiel hinzu.
Fügen Sie einen Wiederherstellungspfad für Fehler hinzu. Warum: Eine Prozedur, die perfekte Ausführung voraussetzt, lässt den Leser beim ersten Fehler im Stich. Aktion: Geben Sie die sicherste Korrektur, den erneuten Versuch oder die Eskalation an. Erfolg: Der Leser kann ohne Raten in den erwarteten Zustand zurückkehren. Wiederherstellung: Wenn keine sichere Wiederherstellung existiert, warnen Sie vor der Aktion und nennen Sie, wer helfen kann.
Dieses Live-Beispiel ist bewusst kompakt, erfüllt aber dennoch den Schrittnvertrag. Der Rest dieser Seite definiert, wie das Element konsistent über Veröffentlichungssysteme hinweg erstellt wird.
Warum dieses Element wichtig ist
Prozedurale Leser möchten wissen, was sie jetzt tun sollen, warum es wichtig ist, ob es funktioniert hat und was zu tun ist, wenn die Realität vom Idealfall abweicht. „Speichern klicken“ beantwortet nur die erste Frage. Es überlässt dem Leser, zu erraten, welche Bestätigung zu erwarten ist und was ein Fehler bedeutet.
Die Schrittliste reduziert diese Unsicherheit, indem sie einen wiederholten Entscheidungsrhythmus schafft. Ein imperativer Titel beginnt mit einem Befehl wie „Verbinden“, „Überprüfen“ oder „Veröffentlichen“. Der Grund schafft Relevanz, bevor der Leser Mühe investiert. Die Aktion liefert genügend Details zur Ausführung. Der Erfolgszustand macht die Fertigstellung beobachtbar. Der Wiederherstellungspfad verhindert, dass eine fehlgeschlagene Aktion zu einer Sackgasse wird. Dies ist der Schrittnvertrag, und jeder sichtbare Schritt muss alle fünf Teile erfüllen.
Dieselbe Regelmäßigkeit verbessert die maschinelle Extraktionsfähigkeit: die Fähigkeit einer Suchmaschine, eines KI-Agenten oder eines Transformationssystems, eine Anweisung zu isolieren, ohne ihre Rolle zu verlieren. Stabile Reihenfolge, beschreibende Titel, explizite Ergebnisse und begrenzte Wiederherstellungsanweisungen ermöglichen es einer Maschine, die Anweisung von ihrer Überprüfung zu unterscheiden.
Zahlen erzeugen diese Bedeutung nicht von selbst. Sie offenbaren Bedeutung, die der Inhalt bereits hat. Wenn die Reihenfolge echt ist, kommuniziert die Nummerierung Abhängigkeit für einen überfliegenden Leser und bewahrt die Position für strukturierte Daten. Wenn die Reihenfolge künstlich ist, erzeugt die Nummerierung ein falsches Versprechen.
Wann man es verwendet
Verwenden Sie eine Schrittliste, wenn der Leser eine Prozedur in der richtigen Reihenfolge ausführen muss und jede abgeschlossene Aktion den Ausgangszustand für die nächste herstellt. Geeignete Anwendungsfälle umfassen die Kontoeinrichtung, Softwarekonfiguration, einen wiederholbaren Analyse-Workflow, eine Migration, eine Reparatursequenz oder einen Veröffentlichungsprozess mit Abhängigkeiten.
Verwenden Sie keine Schrittliste, nur weil Zahlen autoritär aussehen. Verwenden Sie Aufzählungspunkte, wenn die Elemente Optionen, Beispiele, Zutaten oder Eigenschaften sind. Verwenden Sie eine Checkliste, wenn Elemente unabhängige Prüfschritte sind, die in beliebiger Reihenfolge verifiziert werden können. Verwenden Sie eine Vergleichstabelle, wenn der Leser zwischen Alternativen wählt, statt sich auf ein Ergebnis zuzubewegen. Verwenden Sie normale Prosa, wenn es nur ein oder zwei offensichtliche Aktionen gibt und keine eine unabhängige Überprüfung benötigt.
Beinahe-Fehler verursachen die meisten Fehlanwendungen:
- „Zehn Möglichkeiten, eine Landing Page zu verbessern“ ist ein Listicle, es sei denn, Punkt 4 erfordert die Ausgabe von Punkt 3.
- „Überprüfen Sie vor der Veröffentlichung Titel, Links, Bilder und Autor“ ist eine Checkliste, weil die Reihenfolge die Gültigkeit nicht bestimmt.
- „Wählen Sie einen Tarif, geben Sie Zahlungsdaten ein und bestätigen Sie den Kauf“ ist eine Schrittliste, weil jeder Zustand den nächsten freischaltet.
- „Wenn der Import fehlschlägt, versuchen Sie A, B oder C“ ist eine Fehlerbehebungsanleitung. Es wird nur dann zu einer Schrittliste, wenn die Diagnosezweige in einer definierten Reihenfolge ausprobiert werden müssen.
- Eine Chronologie beschreibt, was im Laufe der Zeit passiert ist. Es ist keine Prozedur, es sei denn, der Leser kann ihre Aktionen ausführen, um das angegebene Ergebnis zu erreichen.
Führen Sie den Tauschtest durch, wenn die Absicht unklar ist: Tauschen Sie zwei benachbarte Elemente und fragen Sie, ob die Prozedur korrekt bleibt. Wenn jeder Tausch harmlos ist, ist die Reihenfolge dekorativ und dies ist das falsche Element.
Wo man es platziert
Eine Schrittliste gehört dorthin, wo der Leser das Ergebnis versteht und die erforderlichen Eingaben für den Beginn hat. Platzieren Sie einen Voraussetzungsblock unmittelbar darüber, der den Ausgangszustand, Berechtigungen, Dateien oder Daten, Werkzeuge, Materialien, Zeit und irreversible Risiken nennt. Lassen Sie nicht zutreffende Felder weg; verstecken Sie niemals eine erforderliche Eingabe in Schritt 4.
Platzieren Sie einen Ergebnisblock unmittelbar unter dem letzten Schritt. Er gibt den abgeschlossenen Zustand, das Artefakt oder den Zustand, den der Leser jetzt haben sollte, und die nächste sinnvolle Aktion an. Dies schließt die Prozedur ab, anstatt den Leser raten zu lassen, dass das Fehlen einer weiteren Zahl Erfolg bedeutet.
Das Element kann einmal als Hauptprozedur in einer How-to-Seite oder mehrmals als klar benannte Phasen in einem längeren Tutorial erscheinen. Eine Phasenüberschrift muss das Zwischenergebnis erklären, und die Nummerierung muss entweder phasenübergreifend fortgesetzt werden oder explizite Bezeichner wie „Phase 2, Schritt 1“ verwenden. Starten Sie nicht stillschweigend bei 1 neu.
Eine Schrittliste darf nicht direkt neben einer anderen nummerierten Liste mit einem anderen Zweck stehen; eine Überschrift oder ein Übergang muss die Grenze erklären. Sie darf nicht vor einer Warnung beginnen, die die Sicherheit der Aufgabe beeinflusst. Platzieren Sie keinen allgemeinen Handlungsaufruf zwischen Schritten, setzen Sie keine Referenzen zwischen eine Aktion und ihren Erfolgszustand und fügen Sie keine unzusammenhängende Vergleichstabelle in die Mitte einer Prozedur ein. Begleitmaterial gehört nur dann in den relevanten Schritt, wenn es hilft, diese Aktion abzuschließen; andernfalls platzieren Sie es vor oder nach der vollständigen Sequenz.
Anatomie
Die Anatomie hat drei Sammlungsbereiche und fünf wiederholte Schrittbereiche:
- Voraussetzungen: der Ausgangszustand, Zugriff, Werkzeuge, Materialien, Zeit und wichtige Einschränkungen.
- Sequenzbezeichnung: eine beschreibende Überschrift, die die Prozedur und ihr Ergebnis benennt.
- Schrittnummer: die semantische Position, generiert vom Renderer der geordneten Liste und nicht im Titel eingegeben.
- Imperativer Titel: ein handlungsgeführter Ausdruck, der es einem Überflieger ermöglicht, die Aufgabe vorherzusagen.
- Warum: die Abhängigkeit, das Risiko oder der Nutzen, der die Durchführung des Schrittes jetzt rechtfertigt.
- Aktion: die genaue Anweisung, einschließlich relevantem Ort, Eingabe und Auswahl.
- Erfolg und Wiederherstellung: der beobachtbare erledigte Zustand, gefolgt von der nächsten sicheren Reaktion, wenn dieser Zustand nicht eintritt.
- Ergebnis: der endgültige Zustand und was der Leser damit tun kann.
Die Legende bleibt auf der Seite, weil Bezeichnungen Inhalt sind, keine Grafiken. Wenn sich das Design ändert, müssen dieselben semantischen Bereiche identifizierbar bleiben, ohne Pixel bearbeiten zu müssen.
Designbeispiele
Die Standardvariante behandelt die meisten redaktionellen Prozeduren. Eine kompakte Variante kann den Abstand reduzieren, darf aber keine Vertragsfelder entfernen. Eine Screenshot-gestützte Variante paart einen mehrdeutigen Benutzeroberflächenschritt mit einem fokussierten Bild. Eine Phasenvariante gruppiert eine lange Prozedur nach Zwischenergebnissen, während eine kohärente Gesamtreihenfolge erhalten bleibt.
Keine „minimale“ Variante darf Gründe oder Wiederherstellungspfade weglassen. Die Darstellung kann Leerraum komprimieren, nicht den redaktionellen Vertrag.
Parameter
Diese Parameter definieren Quellinhalt, keine optionale visuelle Dekoration. Die Quellspalte zeigt, ob ein Wert aus einem Attribut, einem verschachtelten Elementkörper oder seiner ersten Überschrift stammt.
| Name | Typ | Erforderlich | Min/Max | Standard | Quelle | |
|---|---|---|---|---|---|---|
title | Einfacher String | Ja | 3–10 Wörter | Keine | Erste Überschrift im übergeordneten Textkörper | |
variant | Aufzählung | Nein | default, compact oder phased | default | Übergeordnetes Attribut | |
totalTime | ISO-8601-Dauer | Nein | 1 Minute bis 30 Tage | Ausgelassen | Übergeordnetes Attribut, unterstützt durch sichtbaren Zeittext | |
prerequisites | Markdown-Block | Ja, wenn Voraussetzungen existieren | 1–6 Elemente; 10–120 Wörter | Nur ausgelassen, wenn keine existieren | Übergeordneter Textkörper vor Elementen | |
steps | Geordnete Elementsammlung | Ja | 3–10 Schritte | Keine; Ziel 5 | Verschachtelte Elementkörper | |
step.title | Einfacher String | Ja | 2–8 Wörter; 60 Zeichen | Keine | Erste Überschrift im Elementkörper | |
step.why | Einfaches Markdown | Ja | 10–35 Wörter | Keine | Elementkörper | |
step.action | Einfaches Markdown | Ja | 15–70 Wörter | Keine | Elementkörper | |
step.success | Einfaches Markdown | Ja | 8–30 Wörter | Keine | Elementkörper | |
step.recovery | Einfaches Markdown | Ja | 8–40 Wörter | Keine | Elementkörper | |
step.image | Stammrelativer Asset-Pfad | Nein | 0–1 Bild pro Schritt | Ausgelassen | Elementattribut; nur nachdem das Asset existiert | |
supply | Sammlung einfacher Strings | Nein | 0–8 sichtbare Elemente | Ausgelassen | Voraussetzungen des übergeordneten Textkörpers | |
tool | Sammlung einfacher Strings | Nein | 0–8 sichtbare Elemente | Ausgelassen | Voraussetzungen des übergeordneten Textkörpers | |
outcome | Markdown-Block | Ja | 15–80 Wörter | Keine | Übergeordneter Textkörper nach Elementen |
Die normale Länge pro Schritt beträgt 50–140 Wörter über die fünf Vertragsfelder. Kürzere Schritte neigen dazu, Begründungen oder Überprüfungen auszulassen; längere Schritte verbergen normalerweise mehrere Aktionen.
Syntax und Codebeispiele
Die kanonische Struktur folgt den Element-Schreibregeln : Der übergeordnete Teil enthält Sammlungseinstellungen, und jeder wiederholte Schritt ist ein verschachteltes Element. Die folgenden Beispiele kodieren denselben Zwei-Schritt-Ausschnitt zur Verdeutlichung der Zuordnung; eine veröffentlichbare Prozedur sollte normalerweise mindestens drei Schritte enthalten.
Portables Markdown-Direktiv
:::step-list{totalTime="PT15M" variant=default}
## Datenquelle verbinden und überprüfen
Voraussetzungen: Administratorzugriff und die Eigenschaftskennung.
::item
### Öffnen Sie den Bildschirm zur Eigenschaftsverbindung
**Warum:** Der Start von der richtigen Eigenschaft verhindert, dass Daten dem falschen Konto zugeordnet werden.
**Aktion:** Öffnen Sie Einstellungen, wählen Sie Datenquellen und wählen Sie die im Voraussetzungsblock angezeigte Eigenschaftskennung.
**Erfolg:** Der ausgewählte Eigenschaftsname erscheint in der Verbindungszusammenfassung.
**Wiederherstellung:** Falls er fehlt, bestätigen Sie den Kontozugriff und laden Sie die Eigenschaftsliste neu.
::
::item
### Führen Sie den Verbindungstest durch
**Warum:** Ein erfolgreicher Test beweist, dass Anmeldedaten und Berechtigungen vor dem ersten Import funktionieren.
**Aktion:** Wählen Sie Verbindung testen und warten Sie auf die Statusantwort.
**Erfolg:** Die Benutzeroberfläche zeigt „Verbunden“ mit einem aktuellen Zeitstempel an.
**Wiederherstellung:** Autorisieren Sie das Konto neu; falls der Test immer noch fehlschlägt, kopieren Sie den Fehlercode für den Support.
::
Ergebnis: Die Quelle ist verbunden und bereit für den ersten Import.
:::
Hugo-Shortcode-Zuordnung
{{< step-list totalTime="PT15M" variant="default" >}}
Voraussetzungen: Administratorzugriff und die Eigenschaftskennung.
{{< step title="Öffnen Sie den Bildschirm zur Eigenschaftsverbindung" >}}
**Warum:** Der Start von der richtigen Eigenschaft verhindert, dass Daten dem falschen Konto zugeordnet werden.
**Aktion:** Öffnen Sie Einstellungen, wählen Sie Datenquellen und wählen Sie die Eigenschaftskennung.
**Erfolg:** Die ausgewählte Eigenschaft erscheint in der Verbindungszusammenfassung.
**Wiederherstellung:** Bestätigen Sie den Zugriff und laden Sie die Eigenschaftsliste neu.
{{< /step >}}
{{< step title="Führen Sie den Verbindungstest durch" >}}...{{< /step >}}
Ergebnis: Die Quelle ist verbunden und bereit für den ersten Import.
{{< /step-list >}}
Diese Notation definiert den Adaptervertrag; Autoren müssen den registrierten Renderer der Website verwenden, wenn er verfügbar ist. Diese Seite rendert ihr Live-Beispiel als semantisches Markdown und führt kein neues Hugo-Shortcode ein.
WordPress-Block-Zuordnung
<!-- wp:amicited/step-list {"totalTime":"PT15M","variant":"default"} -->
<!-- wp:amicited/step {"title":"Öffnen Sie den Bildschirm zur Eigenschaftsverbindung"} -->
<p><strong>Warum:</strong> Der Start von der richtigen Eigenschaft verhindert, dass Daten dem falschen Konto zugeordnet werden.</p>
<p><strong>Aktion:</strong> Öffnen Sie Einstellungen, wählen Sie Datenquellen und wählen Sie die Eigenschaftskennung.</p>
<p><strong>Erfolg:</strong> Die ausgewählte Eigenschaft erscheint in der Verbindungszusammenfassung.</p>
<p><strong>Wiederherstellung:</strong> Bestätigen Sie den Zugriff und laden Sie die Eigenschaftsliste neu.</p>
<!-- /wp:amicited/step -->
<!-- /wp:amicited/step-list -->
Die Ausgabe auf verschiedenen Plattformen kann visuell abweichen, aber jedes Feld und seine Bedeutung müssen erhalten bleiben.
Beispiele
Gut: Eine Domain vor der Datenerfassung verifizieren
- Fügen Sie den Verifizierungseintrag hinzu. Warum: Der Eintrag beweist die Kontrolle über die Domain, ohne Kontodaten preiszugeben. Aktion: Kopieren Sie den genauen TXT-Wert in die DNS-Einstellungen der Domain und speichern Sie ihn auf dem Root-Host. Erfolg: Der Anbieter zeigt den Eintrag in seiner DNS-Liste ohne zusätzliche Anführungszeichen an. Wiederherstellung: Falls er fehlt, überprüfen Sie, ob das Hostfeld das vom Anbieter erforderliche Root-Symbol verwendet, und warten Sie die DNS-Propagation ab, bevor Sie es erneut versuchen.
- Bestätigen Sie den Besitz im Produkt. Warum: Die Bestätigung verhindert, dass die Erfassung gegen eine unverifizierte Eigenschaft startet. Aktion: Kehren Sie zum Verifizierungsbildschirm zurück und wählen Sie Verifizieren, sobald der Eintrag öffentlich auflösbar ist. Erfolg: Der Domainstatus ändert sich auf Verifiziert und zeigt die Verifizierungszeit an. Wiederherstellung: Falls die Verifizierung fehlschlägt, fragen Sie den TXT-Eintrag ab, vergleichen Sie ihn Zeichen für Zeichen und korrigieren Sie den DNS-Eintrag vor einem weiteren Versuch.
- Starten Sie die erste Erfassung. Warum: Eine verifizierte, aber ungenutzte Eigenschaft erzeugt keine Basislinie. Aktion: Wählen Sie Erfassung starten und behalten Sie den Standardumfang bei, es sei denn, das Projekt erfordert eine dokumentierte Ausnahme. Erfolg: Ein Job in der Warteschlange erscheint mit der verifizierten Domain und der aktuellen Zeit. Wiederherstellung: Wenn kein Job erscheint, aktualisieren Sie einmal; erfassen Sie dann die Domain, die Uhrzeit und die Fehlermeldung für den Support, anstatt Duplikate zu erstellen.
Dies funktioniert, weil die Reihenfolge echt ist, die Titel imperativ sind, die Kontrollpunkte sichtbar sind und die Fehleranleitung sicher ist.
Schlecht: Einen Artikel verbessern
- Interne Links hinzufügen.
- Einleitung umschreiben.
- Rechtschreibung prüfen.
- Beispiele hinzufügen.
Die Liste ist aus zwei Gründen schlecht. Erstens ist ihre Reihenfolge willkürlich: Die Rechtschreibung könnte vor den Links geprüft werden, und Beispiele könnten vor der Einleitung hinzugefügt werden. Es sollte eine Checkliste sein. Zweitens nennt jedes Element lediglich eine Aktivität. Keines erklärt, warum es dazugehört, wie weit es gehen soll, was als Erfolg gilt oder was zu tun ist, wenn die Prüfung fehlschlägt. Weitere Verben hinzuzufügen würde die semantische Fehlanpassung nicht beheben.
Granularität und Verschachtelung
Ein Schritt sollte eine sinnvolle Zustandsänderung bewirken. Mehrere Klicks können zu diesem Schritt gehören, wenn sie eine ununterbrochene Interaktion bilden und ein gemeinsames Erfolgssignal teilen. Zum Beispiel ist „CSV auswählen, UTF-8 wählen und die Datei exportieren“ ein Schritt, wenn das beobachtbare Ergebnis eine heruntergeladene CSV ist. Teilen Sie ihn auf, wenn ein Zwischenergebnis eine Überprüfung, eine andere Berechtigung, eine wesentliche Wartezeit, eine Entscheidungsverzweigung oder einen eigenen Wiederherstellungspfad benötigt.
Verwenden Sie den Satztest: Wenn der Titel ein „und“ benötigt, um zwei Ergebnisse zu verbinden, enthält er wahrscheinlich zwei Schritte. Verwenden Sie auch den Fehlertest: Wenn die erste Hälfte erfolgreich sein kann, während die zweite fehlschlägt, und jede eine andere Wiederherstellung benötigt, teilen Sie sie auf.
Die Verschachtelung ist auf eine Ebene und drei kurze Unterschritte beschränkt. Unterschritte klären eine eng umgrenzte Aktion; sie erstellen keine Prozedur innerhalb einer Prozedur. Verschieben Sie die Sequenz auf eine eigene Seite, wenn sie separate Voraussetzungen, mehr als drei Aktionen, mehrere Screenshots, mehr als einen Fehlerzweig oder ein Ergebnis hat, das eine andere Seite unabhängig verwenden könnte. Verlinken Sie auf diese Unterprozedur und halten Sie den übergeordneten Schritt darauf fokussiert, wann sie auszuführen ist und wie das Ergebnis bestätigt wird.
Screenshot-Regel pro Schritt
Ein Screenshot verdient seinen Platz, wenn Worte das Steuerelement oder den Zustand nicht zuverlässig identifizieren können. Verwenden Sie einen, wenn Bezeichnungen dupliziert sind, das Steuerelement in einem Menü versteckt ist, die räumliche Position wichtig ist, die Benutzeroberfläche ein unbekanntes Symbol verwendet oder der Erfolgszustand visuell mehrdeutig ist. Beschneiden Sie auf den Aufgabenbereich, bewahren Sie genügend Kontext zur Orientierung und beschreiben Sie den relevanten Zustand im Alternativtext und im nahen Textumfeld.
Lassen Sie den Screenshot weg, wenn die Benutzeroberflächenbezeichnung eindeutig ist und der Erfolgszustand genau angegeben werden kann. Lassen Sie auch Screenshots von Routineaktionen wie dem Auswählen einer klar beschrifteten Speichern-Schaltfläche, bereits als Text dargestellten Terminalbefehlen oder jedem Bildschirm, der auf dem Weg zu einer sinnvollen Auswahl durchlaufen wird, weg. Vierzehn Screenshots für vierzehn offensichtliche Schritte verwandeln eine Prozedur in eine langsame, spröde Diashow und machen Schnittstellenänderungen teuer in der Wartung.
Verwenden Sie nicht mehr als einen Screenshot pro Schritt. Wenn ein Schritt Vorher-, Während- und Nachher-Bilder benötigt, ist seine Granularität wahrscheinlich zu grob. Verweisen Sie niemals auf ein Asset, bevor es existiert, und legen Sie niemals wesentliche Anweisungen nur innerhalb des Bildes ab.
Schema-Markup und Barrierefreiheit
Schema-Markup
ist maschinenlesbarer Code, der die Bedeutung und Beziehungen von sichtbarem Inhalt beschreibt. Wenn die Seite tatsächlich eine vollständige Prozedur lehrt, kann die Schrittliste ein Schema.org-HowTo-Objekt speisen, das als JSON-LD
ausgedrückt wird. Die Zuordnung ist direkt:
| Sichtbares Feld | HowTo-Eigenschaft | Regel |
|---|---|---|
| Prozedurtitel | HowTo.name | Entspricht der sichtbaren Prozedurüberschrift. |
| Sichtbare Dauer | HowTo.totalTime | Kodieren Sie als ISO-8601-Dauer, z. B. PT15M; erfinden Sie keine Dauer nur für das Markup. |
| Erforderliche Materialien | HowTo.supply / HowToSupply | Fügen Sie nur Verbrauchsmaterialien ein, die in den Voraussetzungen genannt sind. |
| Erforderliche Werkzeuge | HowTo.tool / HowToTool | Fügen Sie nur Werkzeuge ein, die in den Voraussetzungen genannt sind. |
| Geordnete sichtbare Schritte | HowTo.step / HowToStep | Bewahren Sie Anzahl und Reihenfolge exakt. |
| Imperativer Titel | HowToStep.name | Entspricht dem sichtbaren Schritt-Titel. |
| Warum, Aktion, Erfolg, Wiederherstellung | HowToStep.text | Bewahren Sie die gesamte sichtbare Anleitungsbedeutung, nicht nur die Klickaktion. |
| Schritt-Bild | HowToStep.image | Fügen Sie nur das sichtbare Bild ein, das diesem Schritt zugeordnet ist. |
| Schritt-Anker | HowToStep.url | Zeigen Sie auf den stabilen Fragmentbezeichner des sichtbaren Schritts. |
Das Markup muss die sichtbare Prozedur exakt abbilden. Fügen Sie niemals versteckte Schritte hinzu, kombinieren Sie zwei sichtbare Schritte in einem Schema-Element, ordnen Sie sie neu oder lassen Sie Wiederherstellungsanweisungen weg, um die strukturierte Version kürzer zu machen. Wenden Sie HowTo nicht nur an, weil eine Seite eine nummerierte Liste enthält; die Seite muss einen abschließbaren Prozess beschreiben.
Barrierefreiheit beginnt mit einem <ol>, das ein <li> pro Schritt enthält. Die Nummer und Reihenfolge müssen für unterstützende Technologien verfügbar bleiben. Geben Sie keine Zahlen in Überschriften ein, da kopierter Text, CSS-Zähler und Screenreader-Ausgaben inkonsistent sein können. Verwenden Sie logische Überschriftsebenen, stabile Fragmentbezeichner, beschreibende Screenshot-Alternativen und Textbezeichnungen für Erfolg und Wiederherstellung anstelle von Farbe allein.
Vermeiden Sie interaktive Steuerelemente, die die Schrittreihenfolge ändern, ohne die Änderung anzukündigen. Wenn Schritte einklappbar sind, benötigt das Steuerelement einen zugänglichen Namen und erweiterten Zustand, und der Tastaturfokus muss vorhersagbar bleiben. Druckbare und JavaScript-freie Ausgaben müssen die gesamte Prozedur enthalten.
Schreibregeln
Schreiben Sie 3–10 Schritte, normalerweise 50–140 Wörter pro Schritt. Beginnen Sie jeden 2–8 Wörter umfassenden Titel mit einem imperativen Verb und beschreiben Sie ein Ergebnis. Erklären Sie den Grund, bevor eine Aktion ausgeführt wird, die Leser überspringen, umordnen oder missverstehen könnten. Verwenden Sie eine ruhige, direkte Sprache.
Jeder Schritt muss die fünf Vertragsfelder enthalten, auch wenn das gerenderte Design keine sperrigen Bezeichnungen wiederholen muss, wenn die Typografie sie zugänglich vermittelt. Der Erfolgszustand muss beobachtbar sein: ein Status ändert sich, eine Datei existiert, ein Wert liegt innerhalb eines angegebenen Bereichs, eine E-Mail kommt an oder ein Test besteht. „Alles sieht gut aus“ ist nicht beobachtbar. Die Wiederherstellung muss sicher, spezifisch und verhältnismäßig sein; unterscheiden Sie zwischen Wiederholen und Rückgängigmachen und identifizieren Sie die Eskalation, wenn der Leser den Zustand nicht selbst reparieren kann.
Platzieren Sie keinen unzusammenhängenden Hintergrund, keine werblichen Handlungsaufrufe, keine Testimonials, keine zweite unabhängige Prozedur und keine mehreren Entscheidungszweige innerhalb eines Schrittes. Verschieben Sie Hintergrundinformationen über die Liste, Werbung unter das Ergebnis und umfangreiche Verzweigungen in Fehlerbehebungsabschnitte. Verwenden Sie nicht „einfach“, „offensichtlich“ oder „nur“ für eine Aktion, die fehlschlagen könnte. Versprechen Sie niemals einen Bildschirm, eine Bezeichnung, eine Zeit oder ein Ergebnis, das das Produkt nicht tatsächlich liefert.
Beitragstypen, die es verwenden
| Beitragstyp | Verwendung | Position |
|---|---|---|
| How-to-Anleitung | Immer; die geordnete Prozedur ist das Kernversprechen der Seite. | Nach Voraussetzungen und vor dem Ergebnis, der Fehlerbehebung und der nächsten Aktion. |
| Tutorial | In der Regel; verwenden Sie es für jede abhängigkeitsgesteuerte Phase, nicht für konzeptionelle Lehre. | Nach dem für die Phase benötigten Konzept und vor der Phasenüberprüfung. |
| Fehlerbehebungsseite | Manchmal; nur wenn Diagnosen oder Reparaturen in einer sicheren Reihenfolge ausgeführt werden müssen. | Nach dem Symptom und den Sicherheitsprüfungen, vor der Eskalation. |
| Prozess- oder Checklistenseite | Manchmal; verwenden Sie Schritte für den geordneten Ausführungsteil und Kontrollkästchen für unabhängige Prüfschritte. | Zwischen den Prozesseingaben und seiner abschließenden Überprüfungscheckliste. |
| Produkteinrichtungsinhalt | Manchmal; verwenden Sie es, wenn ein Produktzustand den nächsten freischaltet. | Nach Zugriffsanforderungen und vor der Bestätigung oder den nächsten Onboarding-Schritten. |
Das Frontmatter postTypes zeichnet diese Beziehungen für Katalog- und Validierungszwecke auf. Nur registrierte Playbook-Beitragstypseiten erhalten Links; andere Zeilen beschreiben unterstützte redaktionelle Muster, ohne Routen zu erfinden.
QA-Checkliste
Überprüfen Sie vor der Veröffentlichung alle folgenden Punkte:
- Das Vertauschen benachbarter Schritte würde das Ergebnis verändern, blockieren oder ungültig machen.
- Die Voraussetzungen nennen jeden erforderlichen Ausgangszustand, jede Berechtigung, jedes Werkzeug, jedes Material und jedes Risiko.
- Die Prozedur enthält 3–10 Schritte oder dokumentiert eine begründete Ausnahme.
- Jeder Schritt hat einen imperativen Titel, einen Grund, eine Aktion, einen beobachtbaren Erfolgszustand und einen Wiederherstellungspfad.
- Jeder Schritt bewirkt eine sinnvolle Zustandsänderung und bleibt innerhalb einer Verschachtelungsebene.
- Jede Unterprozedur mit eigenen Voraussetzungen oder eigenem Ergebnis wurde separiert.
- Screenshots erscheinen nur dort, wo die Benutzeroberfläche oder der Zustand mehrdeutig ist, mit nicht mehr als einem pro Schritt.
- Der Ergebnisblock gibt an, was jetzt existiert und was der Leser als Nächstes tun kann.
- Die Semantik geordneter Listen, die Überschriftenreihenfolge, Fragment-Links und Alternativtexte funktionieren ohne Farbe oder Skripte.
-
HowTo-Eigenschaften stimmen, sofern vorhanden, exakt mit den sichtbaren Schritten, der Reihenfolge, der Dauer, den Materialien, den Werkzeugen, dem Text und den Bildern überein. - Die Zuordnungen für portables Markdown, Hugo und WordPress bewahren dieselben Felder und Bedeutungen.
- Links und Metadaten bestehen die umfassendere Pre-Publish-QA-Checkliste .
FAQ
Wie viele Schritte sollte eine Schrittliste enthalten? Verwenden Sie 3–10. Setzen Sie ein oder zwei Aktionen in Prosa; gruppieren oder teilen Sie mehr als zehn.
Was macht eine nummerierte Liste zu einer echten Schrittliste? Die Reihenfolge muss das Ergebnis beeinflussen, und jeder Schritt muss den fünfteiligen Vertrag erfüllen.
Benötigt jeder Schritt einen Screenshot? Nein. Fügen Sie nur dann einen hinzu, wenn Worte die Benutzeroberfläche, Position oder den Zustand nicht zuverlässig identifizieren können.
Kann ein Schritt Unterschritte enthalten? Ja, auf einer Ebene. Trennen Sie jede Sequenz mit eigenen Voraussetzungen, eigenem Ergebnis oder mehr als drei Aktionen.
Wann sollte es eine Checkliste werden? Wenn Elemente in beliebiger Reihenfolge erledigt werden können oder unabhängige Prüfschritte sind.
Die Schrittliste ist eines der SEO-Inhaltselemente , das sowohl Verhalten als auch Darstellung trägt. Ihre Qualität zeigt sich, wenn ein Leser sich von einem Fehler erholen und dennoch das versprochene Ergebnis erreichen kann – nicht, wenn die Zahlen nur ordentlich aussehen.
Weitere Tutorials in diesem Bereich
Bereit, es in die Praxis umzusetzen?
Kostenlose Prüfung · 7 Tage testen · keine Kreditkarte