Informationen zu den Inhaltsentwurfsprinzipien von GitHub
Unsere Produktdokumentation unterstützt alle Benutzer*innen von GitHub, bindet sie ein und vermittelt ihnen Wissen. Ein Arbeitsschritt ist der Entwurf des Inhalts, den wir schreiben. Wir folgen diesen Prinzipien beim Entwerfen und Planen von Inhalten.
- Unsere Inhalte sind auf unsere Benutzer*innen ausgerichtet und beziehen sie ein. Wir respektieren alle, die die Dokumentation aufsuchen und Inhalte erstellen, die mit unseren Entscheidungen zu Strategie, Design und Stil für sie geeignet sind.
- Wir erläutern in unseren Inhalten, warum unsere Produkte nützlich sind und wie sie Menschen bei der Umsetzung ihrer Ziele und Prioritäten unterstützen.
- Das Erstellen einer hochwertigen und wertvollen Dokumentation für die GitHub-Community kommt bei uns an erster Stelle.
- Wir erstellen genau so viele Dokumentationen, wie die Community braucht. Zu viel Inhalt erschwert die Suche, und jede weitere Ergänzung macht den Rest unübersichtlicher (GitHub-Zen).
- Wir wenden einen Ship-and-Iterate-Lernansatz an, und passen unsere Prozesse, Methoden und Richtlinien daran an, was wir aus den Erfahrungen, Branchenkenntnissen und der Zusammenarbeit mit unserer GitHub Docs-Community lernen.
Wir stellen allen einen Styleguide und Inhaltsmodelle als Bausteine und Richtlinien zur Verfügung, um Dokumentationen zu entwerfen und zu erstellen.
- Unser Styleguide und unsere Inhaltsmodelle lassen sich auf eine Reihe von Szenarios anwenden.
- Die Entscheidungen dafür treffen wir vor dem Hintergrund, was für Benutzer*innen unserer Dokumentation am besten ist und nicht, was grammatisch oder stilistisch richtig oder falsch ist. Wir sind flexibel und offen für Änderungen, doch auf Einheitlichkeit sollte geachtet werden.
- Wir konzentrieren uns auf die Dokumentation wirkungsvoller und hochwertiger Szenarios, anstatt jeden möglichen Anwendungsfall für die vielen GitHub-Produkte und -Features umfassend abzudecken.
- Klarheit, Sinn, Richtigkeit und Konsistenz haben bei uns oberste Priorität.
- Beim Treffen einer Stil- oder Strukturentscheidung berücksichtigen wir, was Benutzer*innen mit den Informationen tun möchten und wie unsere Inhalte ihre Ziele am besten unterstützen können.
- Wenn eine dokumentationsspezifische Frage nicht durch den Styleguide oder das Inhaltsmodell geklärt werden kann, bewerten wir die Frage anhand dieser Prinzipien und treffen dann eine Entscheidung.