Einführung in die grundlegenden Dokumentationsprinzipien von GitHub
Diese Grundlagen sind für die Dokumentation von GitHub erforderlich. Verwende die nachstehenden Listen, damit deine Beiträge korrekt, barrierefrei, inklusiv und konsistent sind.
Genau
Die Dokumentation ist korrekt und genau.
- Stelle sicher, dass der Inhalt keine faktischen Fehlern enthält.
- Stelle sicher, dass der Inhalt keine Rechtschreib- und Formatierungsfehlern enthält.
Barrierefrei und inklusive
Die Dokumentation richtet sich nach den aktuellsten Standards für Barrierefreiheit und ist inklusive und übersetzungsfreundlich geschrieben.
- Stelle sicher, dass Inhalte den Richtlinien für Barrierefreiheit und Screenshots entsprechen. Weitere Informationen finden Sie unter Erstellen von Screenshots.
- Stelle sicher, dass Inhalte gut übersetzt werden können. Weitere Informationen finden Sie unter Schreiben von zu übersetzenden Inhalten.
Dauerhaft
In der Dokumentation wird eine einheitliche Sprache, ein einheitlicher Ton und ein einheitlicher Stil beibehalten, wodurch für Leser ein einheitliches Erscheinungsbild entsteht.
- Stelle sicher, dass der Inhalt dem Styleguide für GitHub Docs entspricht. Weitere Informationen finden Sie unter Stil-Leitfaden.
- Wende konsistente Terminologie und Benennungskonventionen an.
- Verwende im Inhalt Brandingelemente wie Produkt- und Featurenamen sowie Logos und Farbschemas konsistent.