Dokumentstruktur zur besseren Übersichtlichkeit überarbeiten

[hugh (Hugh Lashbrooke)]

Update (4. Juni 2024): Die ersten Arbeiten zur Umstrukturierung der Dokumentationsthemen sind abgeschlossen, und die neuen Kategorien sind jetzt live. Neue Indexe zeigen an, was Sie darin finden werden. Sie können sie sich hier ansehen: Documentation - Discourse Meta – Wenn Sie feststellen, dass etwas nicht korrekt aussieht, posten Sie es bitte unten!

Nach einer gründlichen Überprüfung unserer aktuellen Dokumentationsstruktur freuen wir uns, mitteilen zu können, dass wir die Kategorisierung unserer Dokumentation verbessern, um die Themen organisierter zu gestalten 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 die benötigten Informationen leichter finden kann.

Was Sie erwarten können

Neue Kategorien

Ab jetzt werden unsere Dokumentationen nach der beschriebenen Aktion oder Funktionalität kategorisiert und getagged. Die bisherigen Gruppierungen nach Benutzerrolle werden entfallen, und wir werden alle Dokumentationsthemen aktualisieren, um anzugeben, welche Benutzerrolle für die beschriebenen Aktivitäten erforderlich ist.

Vorübergehende visuelle Änderungen

Während dieser Umstrukturierung können Sie feststellen, dass einige Bereiche unserer Dokumentation etwas unpassend oder unorganisiert aussehen. Keine Sorge! Dies ist nur vorübergehend, während wir an der endgültigen Struktur arbeiten.

Umfassende Aktualisierungen

Sobald die Umstrukturierung abgeschlossen ist, werden wir als nächsten Schritt alle Dokumentationsthemen an einem neuen, gemeinsamen Styleguide anpassen. Wir werden auch eventuelle Ungenauigkeiten korrigieren. Dies wird ein laufendes 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, für uns von unschätzbarem Wert. Wenn Sie auf Probleme stoßen oder Vorschläge haben, wie wir unsere Dokumentation weiter verbessern können, zögern Sie nicht, Ihre Gedanken in Contribute > Site feedback oder als Beitrag zu diesem Thema zu teilen.

Vielen Dank für Ihre Geduld, während wir diese Änderungen vornehmen!

[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.