Schnellstartanleitungen ermöglichen es Benutzer*innen, eine einzelne, bestimmte Aufgabe schnell zu erledigen, indem sie einen Workflow nur mit wichtigen Schritten in etwa fünf Minuten oder 600 Wörtern erläutern. Schnellstartanleitungen können verwendet werden, um schnell ein neues Tool einzurichten oder eine andere Aufgabe schnell abzuschließen. Verwenden Sie für komplexere Aufgaben ein Tutorial.
Schnellstarts sind nützlich, wenn jemand das Feature oder Produkt bereits versteht und bereit ist, es auszuprobieren.
Wir bezeichnen Tutorials und Schnellstartanleitungen auf der gesamten Website als „Anleitungen“. Auf /guides-Startseiten stellen wir Tutorials, Schnellstartanleitungen und bestimmte prozedurale Artikel in der Liste der Anleitungen für eine Dokumentationsgruppe bereit.
Schreiben einer Schnellstartanleitung
Die Schnellstartvorlage findest du unter Vorlagen.
Inhalt von Schnellstartanleitungen:
- Einführung:
- Hier wird hervorgehoben, dass die Anleitung kurze und präzise Formulierungen enthält. Bespiele:
- Schnelles Hinzufügen von [FEATURE] zu deinem Projekt
- Grundlagen für die ersten Schritte mit [PRODUKT]
- Gekürzte Anleitung für Personen, die mit [FEATURE] vertraut sind
- Die Zielgruppe wird deutlich genannt.
- Die Voraussetzungen und erforderlichen Vorkenntnisse werden deutlich genannt.
- Es wird erläutert, was erreicht oder erstellt wird.
- Hier wird hervorgehoben, dass die Anleitung kurze und präzise Formulierungen enthält. Bespiele:
- Prozedurale Abschnitte
- Basierend auf der Zielgruppe der Schnellstartanleitung können die Schritte weniger explizit und formal sein als diejenigen, die in prozeduralen Inhalten verwendet werden. Sie müssen keine vorhandenen wiederverwendbaren Elemente verwenden, um diese Schritte zu erstellen, wenn die Zielgruppe diese Detailebene nicht erfordert.
- Erstellen Sie Verknüpfungen zu anderen Artikeln oder Ressourcen, anstatt diese zu replizieren, um zu vermeiden, dass der Informationsfluss unterbrochen wird.
- Geben Sie visuelle Hinweise. Verwenden Sie Codeblöcke und Screenshots, sodass Personen wissen, dass sie die richtigen Aktionen ausführen.
- Problembehandlung (optional)
- Wenn für die Schnellstartanleitung relevante Inhalte zur Problembehandlung vorhanden sind, stelle Links zu diesen Inhalten bereit.
- Nächste Schritte
- Stellen Sie als Übergang zu den nächsten Schritten eine kurze Zusammenfassung der in der Schnellstartanleitung abgeschlossenen Schritte bereit.
- Schließen Sie zwei bis drei handlungsrelevante nächste Schritte ein, die nach Abschluss der Schnellstartanleitung ausgeführt werden können. Fügen Sie immer Links zu konzeptionellen Inhalten für das Feature oder Produkt ein. Sie können auch Links zu anderen zusammenhängenden Informationen auf docs.github.com oder in GitHub Skills einfügen.
Titelrichtlinien für Schnellstartanleitungen
- Stelle dem Titel „Schnellstartanleitung“ voran (z. B. „Schnellstartanleitung für GitHub Actions“ oder „Schnellstartanleitung: Prozeduraler Titel“), wenn die Anleitung jemandem bei den ersten Schritten mit einem neuen Tool helfen soll.
- Befolge für andere Anwendungsfälle die Titelrichtlinien für Prozeduren, und lasse das Wort „Schnellstartanleitung“ weg.