Informationen zur GitHub-Dokumentationsphilosophie
Als Zuhause der weltweit größten Entwicklercommunity möchten wir sicherstellen, dass unsere Dokumentation genau, nützlich, inklusiv und einfach zu verwenden ist. Unsere Dokumentationsphilosophie hilft uns bei der Verwirklichung dieser Ziele.
- Wir setzen uns für unsere Benutzer*innen ein, und das an jedem Punkt des Dokumentationsprozesses – von der Planung über das Schreiben bis hin zur Veröffentlichung. Wir reagieren auf Feedback und arbeiten proaktiv daran, eine möglichst reibungslose Nutzung der GitHub Docs-Website zu ermöglichen.
- Wir schreiben für ein internationales Publikum, damit unsere Inhalte übersetzungsfreundlich und für alle Menschen inklusiv sind.
- Wir erstellen Inhalte, auf die eine breite Gruppe von Benutzer*innen zugreifen kann. Unser Inhaltstoolkit enthält Ressourcen und Anleitungen, um Barrieren für Menschen mit Behinderungen zu verringern, und wir möchten stets mit den aktuellen Standards der Barrierefreiheit Schritt halten.
- Wir erstellen aufgabenbasierte Inhalte. Wir berücksichtigen die Ziele unserer Benutzerinnen bei der Verwendung von GitHub und erstellen daraufhin Inhalte, die den Benutzerinnen helfen, ihre Ziele zu erreichen und neue Möglichkeiten zu entdecken.
- Wir arbeiten mit Teams in GitHub und der Open-Source-Community zusammen, um qualitativ hochwertige Inhalte zu erstellen.
- Wir lernen stets dazu und arbeiten an Verbesserungen, um Benutzer*innen eine möglichst reibungslose Nutzung von GitHub zu ermöglichen.