Mit prozeduralen Inhalten können Benutzer*innen bei Verwendung von GitHub eine Aufgabe von Anfang bis Ende erledigen.
Wir erstellen prozedurale Artikel und Abschnitte innerhalb längerer Artikel.
Schreiben von prozeduralen Artikeln
Informationen zur prozeduralen Inhaltsvorlage findest du unter Vorlagen.
- Befolge die Stilrichtlinien für prozedurale Schritte unter Styleguide.
- Prozedurale Inhalte können sich wiederholen. Suche nach Möglichkeiten, zusammenhängende Inhalte in einem einzelnen längeren Artikel zu gruppieren.
- Gruppieren Sie mehrere zusammenhängende Prozeduren in einem einzelnen Artikel, es sei denn, es gibt einen Grund, dies nicht zu tun.
- Wenn das Deaktivieren einer Einstellung oder das Rückgängigmachen einer Aufgabe dieselben Schritte erfordert und keine besonderen Auswirkungen hat, schreibe keine separate Prozedur.
- Wenn das Deaktivieren einer Einstellung oder das Rückgängigmachen einer Aufgabe unterschiedliche Schritte erfordert oder wichtige oder besondere Auswirkungen hat, erstelle einen längeren Artikel, der beide Prozeduren enthält. Verwenden Sie einen agnostischen Titel.
- Informieren Sie die Leser*innen über das erwartete Ergebnis der Prozedur.
- Fügen Sie so oft wie möglich Tipps zur Problembehandlung ein.
Titel für prozedurale Inhalte
- Prozedurale Artikel oder Abschnitte innerhalb von Artikeln sind aufgabenbasiert und beginnen mit einem Gerundium.
- Verwenden Sie beispielsweise „Anwenden für ein Student Developer Pack“.
- Verwenden Sie aktive und bestimmte Verben (Brainstorming oder ggf. Verwendung eines Thesaurus).
- Titel beschreiben ausdrücklich die Aufgabe, die im Artikel oder der Überschrift enthalten ist, sind jedoch allgemein genug, um den gesamten Inhalt widerzuspiegeln.
- Artikeltitel dürfen maximal 80 Zeichen lang sein (nach Möglichkeit 60 Zeichen).