In letzter Zeit haben wir uns bemüht, unsere Dokumentation hier auf Meta zu verbessern. Dabei konzentrieren wir uns darauf, Dinge so zu kategorisieren, dass verschiedene Benutzer relevante Themen finden und irrelevante Themen ignorieren können.
Wir beabsichtigen, dass alle Dokumentationen in eine der folgenden Kategorien fallen:
- #documentation:users - allgemeine Nutzung
- #documentation:moderators - Moderation einer Community
- #documentation:theme-developers - Entwicklung von Themes und Theme-Komponenten
- #documentation:admins - Administration einer Discourse-Site
- #documentation:devs - Entwicklung von Discourse-Funktionen, Plugins und Integrationen
- #documentation:sysadmin - Systemadministration für selbst gehostete Installationen
Wir planen, #documentation:faq und #documentation:tips-and-tricks Ende dieses Monats zu entfernen (haben aber bereits begonnen, einige Themen in den neuen Kategorien mit #tips-and-tricks zu versehen).
Außerdem beabsichtigen wir, Dokumentationen mit einem der folgenden Klassifizierungs-Tags zu versehen, die von Divio übernommen wurden, gemäß diesem früheren Beitrag:
Die Dinge passen nicht immer perfekt. In einigen Fällen teilen wir Themen auf, in anderen verwenden wir einfach das Tag oder die Kategorie, die am besten zu ihrem aktuellen Zustand passt.
Einige gängige Änderungen, die wir bisher an einzelnen Themen vorgenommen haben (wir sind jetzt etwa 50% fertig).
- Verschieben von #documentation:admins nach #documentation:sysadmin, wenn Konsolenzugriff erforderlich ist.
- Aufteilen von #documentation:faq-Themen in Themen für #documentation:admins und Themen für #documentation:users.
- Verschieben von Themen von #documentation:devs nach #documentation:theme-developers, wenn sie sich speziell auf die Entwicklung von Themes oder Theme-Komponenten beziehen.
- Aktualisieren von Themenüberschriften für mehr Konsistenz
- Verwendung des Imperativs für Themenüberschriften (und Entfernen von “how to” aus der Überschrift).
- Verwendung normaler Satzzeichensetzung
- Formatieren von Inhalten mit Überschriften ab H2
(Verwandt: Wir haben auch das Inhaltsverzeichnis für alle Dokumentations-Themen aktiviert)
In einigen Fällen nehmen wir Änderungen am Inhalt selbst vor, aber eine tiefgreifende Überarbeitung ist nicht unser unmittelbares Ziel. In einem zukünftigen Durchgang möchten wir Folgendes tun:
- Einbeziehung von Inhalten aus Antworten in die Dokumentation selbst
- Löschen aller Antworten
- Konfigurieren von Themen zum Löschen von Antworten nach 1 oder 2 Monaten
Anschließend werden wir aktualisierte Anleitungen zur Erstellung neuer Dokumentationen und zur Pflege bestehender Dokumentationen bereitstellen und die folgenden Themen aktualisieren:
Möglicherweise möchten wir mehr Dokumentationen zu Wikis machen oder neue Besitzer für Dokumentationen finden, wenn diese von jemand anderem als dem ursprünglichen Poster gepflegt werden, zum Beispiel.
Wir denken auch, dass es hier eine Gelegenheit geben könnte, separate Bereiche für Leute zu schaffen, die mehr “Show and Tell” betreiben möchten, ähnlich wie einige der Inhalte, die unter #documentation:tips-and-tricks liefen. Die Schaffung von Räumen für solche Themen außerhalb der Dokumentation könnte mehr Raum für Diskussionen unter Gleichgesinnten bieten. Aber ähnlich wie bei dem, was wir jetzt mit der Dokumentation tun, wäre es vielleicht hilfreich, separate Bereiche für Systemadministratoren, Administratoren und Entwickler für diese Diskussionen zu haben. Was denkst du?