Neues Dokumentations-Plugin in Entwicklung

Ankündigungen
,
1

Wir haben kürzlich unser neues Dokumentations-Plugin zum Testen und Feedback bereitgestellt. Dieses Plugin wurde entwickelt, um die Navigation und Zugänglichkeit von Dokumentationen, die auf Discourse gehostet werden, zu verbessern und allen Benutzern eine zugänglichere und benutzerfreundlichere Erfahrung zu bieten. Beachten Sie, dass sich dieses Plugin noch in der Entwicklung befindet.

Die Entwicklung dieses Plugins ist Teil unserer fortlaufenden Bemühungen zur Verbesserung der Dokumentation, die bereits durch eine neue Seitenleiste verbessert wurde. Die Arbeit an der Seitenleiste legte den Grundstein für eine deutlich verbesserte Dokumentationserfahrung, und das neue Plugin baut schrittweise auf dieser Arbeit auf.

:boom: Das neue Plugin in Aktion

Das Plugin ist derzeit aktiv und versorgt die Dokumentation auf unserer offiziellen Discourse-Dokumentation mit Strom. Wir laden Sie ein, seine Funktionen zu erkunden und Ihre Erfahrungen mit uns zu teilen. Ihr Feedback ist für uns von unschätzbarem Wert, um das Plugin zu verfeinern und zu verbessern.

Die Kernfunktionen des neuen Plugins sind:

  • Einstellungen zur Definition, welche Kategorien für die Dokumentation verwendet werden
  • Eine neue Dokumentations-Seitenleiste, die von Index-Themen innerhalb jeder Kategorie gefüllt wird
  • Zwei neue Berichte zur Aufrechterhaltung der Integrität und Genauigkeit von Index-Themen

Weitere Funktionen sind in Entwicklung, da wir die verfügbaren Funktionen kontinuierlich verbessern.

Das neue Plugin kann ab sofort heruntergeladen und installiert werden: Discourse Doc Categories

:electric_plug: Umstellung vom Discourse Docs Plugin

Während wir innovativ sind und voranschreiten, werden wir unser älteres Discourse Docs Plugin einstellen. Sie können jedoch sicher sein, dass wir es weiterhin unterstützen werden, bis das neue Plugin vollständig für eine breite Veröffentlichung bereit ist. Wir haben auch sichergestellt, dass das neue Plugin URLs vom alten Plugin umleitet, sodass ein Wechsel keine defekten Links zur Folge hat.

Bitte beachten Sie, dass sich das neue Plugin noch in der experimentellen Phase befindet. Obwohl wir bestrebt sind, eine nahtlose Erfahrung zu bieten, kann es Bereiche geben, die weitere Verbesserungen erfordern. Ihr konstruktives Feedback ist entscheidend für seinen Erfolg.

:speaking_head: Lassen Sie uns wissen, was Sie denken

Wir würden uns über Ihre Gedanken, Erfahrungen und Ihr Feedback freuen. Teilen Sie uns gerne Ihre Erfahrungen und Erkenntnisse mit, die Sie bei der Verwendung des neuen Dokumentations-Plugins sammeln, entweder durch Navigation durch die Dokumentation auf Meta oder durch Installation des Plugins auf Ihrer eigenen Website.

Unser Ziel ist es, eine bessere Dokumentationserfahrung für die gesamte Discourse-Community zu gestalten, daher ist jedes Feedback willkommen!

Vollständige Plugin-Details finden Sie hier:

13 „Gefällt mir“
2

Jemand muss die Readme aktualisieren. Und vielleicht die Lint-Regeln aktualisieren, um das zu verhindern, obwohl es ein Henne/Ei-Problem gibt.

Es sieht so aus, als ob es auch großartig für die Verwendung von Discourse als LMS wäre. Dafür wäre es gut, umschalten zu können, welche Kategorie eine Dokumentationskategorie war, obwohl die Wahrscheinlichkeit groß ist, dass die Verwendung von Berechtigungen, um Benutzern den Zugriff auf bestimmte Kategorien zu gewähren, ausreicht, damit es einfach funktioniert.

8 „Gefällt mir“
3

Guter Fang der URL – ich habe gerade einen PR eingereicht, um das hinzuzufügen.

Das klingt nach einem interessanten Anwendungsfall dafür, und ich kann sehen, wie das ziemlich gut funktionieren würde!

6 „Gefällt mir“
4

Dies ist eine fantastische Verbesserung gegenüber dem ursprünglichen Docs/Knowledge Base-Plugin. Bisher scheint es sehr benutzerfreundlich zu sein.

Das Testen auf Meta ist definitiv ein riesiger Vorteil, da die Dokumentationskategorien hier bisher schwer zu finden waren.

5 „Gefällt mir“
5

Darf ich nach einer Zeitschätzung fragen? D.h. wann dieses Plugin als weniger experimentell und mehr als Beta- oder vielleicht sogar als Early Release Candidate-Phase betrachtet wird? Ich weiß, wie schwer es ist, die Zukunft vorherzusagen, daher freue ich mich über jede grobe Schätzung, egal wie ungenau sie sein mag. :wink:

Ich untersuche derzeit Discourse als Werkzeug bei der Arbeit, gerade weil es in der Lage zu sein scheint, eine gute Mischung aus Community-Diskussionen und einem gemeinsamen Raum für Dokumentation zu bieten. Wo es so einfach ist, Dokumentation zu schreiben, wie einen Kommentar zu einem Thema zu posten.

Daher ist die Wiki-Themenfunktion an sich natürlich nett, das ist ein guter Anfang. Dieses Plugin fügt jedoch Kohäsion zum Inhalt der Themen hinzu, was meiner Meinung nach für die Benutzererfahrung von Dokumentationen unerlässlich ist.

Die Dokumentationskategorie auf meta.discourse.org fühlt sich jetzt wie eine richtig strukturierte Dokumentationsseite an, anstatt nur einige zufällige Forumsthemen, die zufällig eine Kategorie teilen und zufällig beschreiben, wie Discourse funktioniert.

Also, weiter so. Danke!

1 „Gefällt mir“
7

Ich mag es sehr! Dokumentation und Diskurse passen sehr gut zusammen.

Haben Sie Pläne, zusätzlich zu Kategorien auch Tags zu indizieren?

8

Ich denke, die Phase, in der wir uns gerade befinden, ist “Schönheit (oder deren Fehlen) liegt im Auge des Betrachters”.

Es ist experimentell in dem Sinne, dass es bekannte UX-Probleme gibt, insbesondere für diejenigen, die für die Pflege der Dokumentation und insbesondere der Indizes verantwortlich sind, aber es ist absolut sicher in der Produktion zu verwenden.

Alles in allem würden wir uns sehr über Ihr Feedback freuen, wenn Sie es ausprobieren und selbst auf Herz und Nieren prüfen.

Wir haben derzeit keine ETA für die Verbesserung der bekannten UX-Probleme bei der Indexpflege, aber Feedback von Leuten, die es verwenden, könnte helfen, die Richtung dort zu bestimmen.

Nein, das ist bisher noch nirgends aufgetaucht. Können Sie etwas mehr darüber erzählen, was Sie sich vorstellen oder warum das für Sie hilfreich wäre?

4 „Gefällt mir“
9

Dazu: Wenn Sie sich in einer Dokumentenkategorie befinden und ein nicht vollbildschirmiges Chatfenster schließen, wird auch die Dokumentennavigation „geschlossen“ und die normale Navigationsleiste wird wieder angezeigt. Während der Reproduktion auf Meta habe ich auch festgestellt, dass ein Klick auf die Sprechblase (oben rechts in der Kopfzeile) auch die Dokumentennavigation schließt. Ich hoffe, das hilft!

3 „Gefällt mir“
11

Danke für die Meldung – ich kann dies reproduzieren, habe es daher protokolliert und wir werden es in die bevorstehende Entwicklungsarbeit hier aufnehmen.

3 „Gefällt mir“
13

Das erinnert mich an eine Sache bei Discourse als Projekt, die für mich als Benutzer nicht wirklich ideal ist. Die Tatsache, dass das Projekt kein richtiges öffentliches Issue-Tracking-System für Fehler und Planung verwendet.

Wenn ich zum Beispiel Hughs Antwort lese, stellt mein interner Projektmanager sofort die Frage: Wo, wo wurde das protokolliert? Ich weiß, mein interner PM ist ein neugieriges kleines Wesen, nicht wahr? :slight_smile:

Ich nehme an, die Verwendung von meta.discourse.org als Issue-Tracker gibt dem Projekt die Möglichkeit, Discourse selbst zu nutzen. Und alle anderen Issue-Tracker haben ihre eigenen Nachteile, so dass es mühsam ist, einen auszuwählen. Aber für mich ist Discourse – obwohl es als Forum für Fragen und Diskussionen ausgezeichnet ist – als Issue-Tracker sehr mangelhaft. Zu diesem Zweck fehlen ihm effektive Kategorisierung, Informationen über betroffene und Zielversionen, Issue-Nummern, Priorisierung, effektive Mittel zum Filtern von Issues nach Status, Alter, Priorität, Produkt oder Komponenten und eine gute Möglichkeit, eine Roadmap für ein Feature oder das Produkt als Ganzes darzustellen, unter anderem.

Nun, ich schweife ab. Und ich habe noch keine einzige Zeile Code, keinen Fehlerbericht und keine Funktionsanfrage beigesteuert, also wer bin ich, mich zu beschweren. :wink:

Also, nochmals vielen Dank an alle für die Großartigkeit von Discourse. Und entschuldigen Sie die halbe Tirade.

Und zum Thema: Großartig zu hören, dass Discourse Doc Categories, obwohl noch nicht poliert, architektonisch stabil ist. Ich werde prüfen, ob ich es auf meiner gehosteten Discourse-Instanz installieren kann und dann versuchen, mit Feedback zurückzukommen. Danke!

6 „Gefällt mir“
14

Ich habe vergessen, hier zu antworten. Danke für Ihre Nachfrage.

Ich verstehe, dass #wiki in verschiedene Kategorien wie community support dev passen könnte und es besser ist, Daten basierend auf den Interessen der Benutzer an Themen anzuzeigen.

In der Zwischenzeit klingt es schön, diese Wikis, die in der Dokumentation (Link in der Wiki-Seitenleiste) organisiert sind, anzuzeigen.

1 „Gefällt mir“
15

Wir verwenden Discourse als Issue-Tracker. Besser gesagt – ich versuche, mein Team zu zwingen, Discourse als Issue-Tracker zu verwenden :slight_smile: Und als Wiki, und als Forum, und als Dokumentation… Ich vermute, das CDCK-Team hat eine weitere „geheime“ Discourse-Seite, auf der sie intern ihre Sachen verfolgen, mit einigen interessanten Plugins, die niemand hat…

Egal wie gut der Issue-Tracker hier ist, die Community ist mit nichts anderem vergleichbar, was ich kenne. Am Ende sind es die Leute, die die Software entwickeln, nicht die Technologie dahinter. Und sie sind spitze! :metal:

Und ich mag das Dokumentations-Plugin sehr. :heart:

Wäre es angesichts all meines Lobes möglich, meinen PR zu genehmigen? :smiley:

5 „Gefällt mir“
16

Hast du Gerhards Antwort auf diesen PR gesehen?

3 „Gefällt mir“
17

Wir haben eine weitere Seite, die wir intern nutzen, und so verfolgen wir tatsächlich einen Großteil unserer Arbeit. Aber wir tun dies nicht mit geheimen Plug-ins.

Hauptsächlich verwenden wir Konventionen, wie eine Kategorie für „Todos“ und eine Standardmenge von wenigen Tags für eine Art „Jetzt/Nächstes/Später“-Priorisierung, zusammen mit dem Zuweisungs-Plug-in, um die Zuständigkeit zu klären.

Das ermöglicht auch die Arbeit des Kanban-Theme-Komponenten, aber nicht jeder nutzt diese Ansicht.

Es ist ziemlich fließend, kein stark meinungsbildender Issue-Tracker, aber es funktioniert gut für uns.

Ich könnte irgendwann mehr Details mitteilen…

6 „Gefällt mir“
18

Nein! Mein Fehler. Behoben. Danke für den Hinweis.

3 „Gefällt mir“