Umstrukturierungsdokumentation für bessere Klarheit

[hugh (Hugh Lashbrooke)]

Update (4. Juni 2024): Die anfängliche Arbeit zur Umstrukturierung der Dokumentationsthemen wurde abgeschlossen, und die neuen Kategorien sind jetzt live mit neuen Indizes, die zeigen, was Sie darin finden werden. Sie können sie hier einsehen: Documentation - Discourse Meta - wenn Ihnen etwas auffällt, das nicht korrekt aussieht, posten Sie bitte unten!

Nach einer gründlichen Überprüfung unserer aktuellen Dokumentationsstruktur freuen wir uns, Ihnen mitteilen zu können, dass wir dabei sind, die Kategorisierung unserer Dokumentation zu verbessern, um die Themen besser zu organisieren und auf die Ziele auszurichten, die unsere Community erreichen möchte. Unser Ziel ist es, die Klarheit und Benutzerfreundlichkeit unserer Dokumentation zu verbessern, damit jeder leichter die benötigten Informationen finden kann.

Was Sie erwarten können

Neue Kategorien

Zukünftig werden unsere Dokumentationen nach der beschriebenen Aktion oder Funktionalität kategorisiert und mit Tags versehen. Die aktuellen Gruppierungen nach Benutzerrolle werden wegfallen, und wir werden alle Dokumentationsthemen aktualisieren, um anzugeben, welche Benutzerrolle zur Durchführung der darin beschriebenen Aktivitäten erforderlich ist.

Vorübergehende visuelle Änderungen

Während dieser Umstrukturierung können Ihnen einige Abschnitte unserer Dokumentation etwas fehl am Platz oder unorganisiert vorkommen. Keine Sorge! Dies ist nur vorübergehend, während wir daran arbeiten, die neue Struktur zu finalisieren.

Umfassende Aktualisierungen

Sobald die Umstrukturierung abgeschlossen ist, werden wir als nächsten Schritt alle Dokumentationsthemen aktualisieren, um sie an einen neuen, gemeinsamen Styleguide anzupassen. Wir werden auch alle bestehenden Ungenauigkeiten korrigieren. Dies wird ein fortlaufendes Projekt sein, wobei der Großteil der Arbeit in den nächsten Wochen erledigt wird.

Wie Sie helfen können

Ihr Feedback ist wie immer von unschätzbarem Wert für uns. Wenn Sie auf Probleme stoßen oder Vorschläge haben, wie wir unsere Dokumentation weiter verbessern können, zögern Sie bitte nicht, Ihre Gedanken in Site feedback oder als Beitrag zu diesem Thema mitzuteilen.

Vielen Dank, dass Sie uns bei diesen Änderungen unterstützen!

[Moin]

Themen zur Moderation wie Discourse Moderation Guide sind Teil von Documentation > Site Management. Vielleicht sollte das zur Beschreibung hinzugefügt werden, denn als Moderator würde ich keine Themen in einer Kategorie für „Site-Besitzer und Administratoren“ suchen.

Site Management

[mcwumbly (Dave McClure)]

Ich habe den Text über uns leicht angepasst, um darauf hinzuweisen, dass er auch für Moderatoren nützlich ist.

@JammyDodger und/oder @hugh haben möglicherweise auch zusätzliche Gedanken, wenn sie dies später sehen.

[JammyDodger]

Ich habe es noch etwas angepasst:

Site Management

[hugh (Hugh Lashbrooke)]

Danke, dass du das hervorgehoben hast, @Moin!

@JammyDodger Dein Update sieht für mich gut aus.

[hugh (Hugh Lashbrooke)]

Die anfängliche Arbeit zur Umstrukturierung der Dokumentationsthemen wurde abgeschlossen, und die neuen Kategorien sind jetzt mit neuen Indizes live, die zeigen, was Sie darin finden werden.

Sie können sie hier überprüfen: Documentation - Discourse Meta - wenn Ihnen etwas auffällt, das nicht korrekt aussieht, posten Sie bitte unten!

[Moin]

Planen Sie, die neuen Kategorien zum Docs-Plugin hinzuzufügen?

[JammyDodger]

Wir sind hin- und hergerissen, ob wir das Docs-Plugin ausprobieren oder nicht. Vorerst habe ich die neuen Kategorien hinzugefügt.

[NateDhaliwal]

Darf ich erfahren, wie der Text der Links zu Themen in der Seitenleiste in einer Unterkategorie erstellt wird? KI?

[hugh (Hugh Lashbrooke)]

Jede Unterkategorie hat ein Index-Thema, zum Beispiel: Using Discourse Index (diese sind aus der Beschreibung in der Kopfzeile jeder Unterkategorie verlinkt).

Die Seitenleiste verwendet die gekürzten Titel von dort, um sie anstelle der vollständigen Artikeltitel zu verwenden.