Mehr Hinweise im gesamten Discourse einfügen, die zu relevanten Docs auf Meta verlinken

Kontext

Das Discourse-Team hat an mehreren Stellen erwähnt, dass es die Benutzererfahrung für Administratoren verbessern möchte.

Problem

Es gibt viele Einstellungen in Discourse und viel Dokumentation. Aber es ist unwahrscheinlich, dass Sie die richtige Dokumentation im richtigen Moment finden.

Funktion

Es könnte viel mehr Stellen in den Discourse-Einstellungen und Menüs geben, an denen die entsprechende Dokumentation unter \u003chttps://meta.discourse.org/docs\u003e verlinkt ist.

Zum Beispiel gibt es den Blogbeitrag Understanding Discourse Trust Levels, der in Discourse-Installationen verlinkt ist.

Aber es gibt noch viele mehr, die es nicht sind.

Zum Beispiel gibt es eine Anleitung zum Löschen einer Kategorie.

Es scheint, dass dies relevant/hilfreich wäre, um es in das Modal einzufügen, in dem Sie die Schaltfläche zum Löschen von Kategorien sehen können.

Es könnte ein Link sein, aber es muss nicht nur ein Link für jeden Fall sein – es könnte ein Fragezeichen-Button sein, der zum Dokument verlinkt, oder es könnte “Mehr lesen…” usw. sein.

Das Discourse-Team könnte die Dokumentation durchgehen, beginnend mit den wichtigsten, und herausfinden, wo in der Software der relevanteste Ort wäre, um auf dieses Dokument zu verlinken.

(Auch bekannt als “just in time”)

Andere Softwarebeispiele

Ghost (eine Open-Source-Blog-Software) hat einige Stellen, an denen ihre Dokumentation verlinkt ist, genau dann, wenn Sie sie brauchen.

Z. B. verlinkt dieser “Mehr erfahren”-Button zum entsprechenden Dokument:

Das Gleiche gilt hier:

Ich war mir nicht sicher, ob dies unter Feature oder UX fällt, verschieben Sie es gerne.

5 „Gefällt mir“

Ich muss dem leicht widersprechen. Es gibt verschiedene Arten von Hilfsinhalten, die Sie erstellen können. Wenn wir uns am Diátaxis-Modell orientieren, sind das Tutorials, Anleitungen, Referenzen und Erklärungen.

Tutorials haben wahrscheinlich einen Platz, um in der App verlinkt zu werden, so dass Sie, wenn Sie auf einer Seite mit der Absicht “Ich möchte lernen, wie das funktioniert” landen, es lernen können, auch wenn die Seite nicht selbsterklärend ist. Vielleicht sogar ein Tutorial-Center, das Ihnen im Grunde ermöglicht, einen Kurs über die Software zu absolvieren, wenn Sie möchten.

Mit den anderen 3 Kategorien habe ich einige Probleme.

Wenn ich zur Seite mit den Kategorieeinstellungen gehe, gibt es vielleicht 20 verschiedene Dinge, die ich tun möchte. Eine Anleitung dort zu platzieren, würde zu einer Liste führen, die ich durchsuchen müsste – und weil ich die Erwartung habe, dass das, wonach ich suche, nicht unbedingt einen dedizierten Anleitungsartikel hat, werde ich diese Frage wahrscheinlich eher bei Google eingeben, als die Liste zu durchsuchen.

Externe Referenzen sind ein Übel, mit dem ich täglich zu kämpfen habe. Wir haben ein “Referenzhandbuch”, das Ihnen sagt, was jeder Schieberegler und jede Schaltfläche tut, bis hin zu:

Abbrechen-Schaltfläche: Schließt das Dialogfeld, ohne Änderungen anzuwenden.
OK-Schaltfläche: Schließt das Dialogfeld und wendet die Änderungen an.

Die Verwendung dieser Referenz bedeutet, dass Sie an viel technischem Zeug vorbeiscrollen müssen, bevor Sie zu Ihrem Abschnitt gelangen, wenn Sie eigentlich nur einen Tooltip benötigten, der eine Option mit ein paar Worten umformuliert.

Wenn ich versuche, eine Kategorie zu löschen, ist das aktuelle Verhalten fast wünschenswert. Ich sehe die Schaltfläche, normalerweise ausgegraut, aber mit einem Fragezeichen, und wenn ich darauf klicke, heißt es:

Diese Kategorie kann nicht gelöscht werden, da sie Unterkategorien enthält.

oder:

Diese Kategorie kann nicht gelöscht werden, da sie 25852 Themen enthält. Das älteste Thema ist…

Das Verhalten ist gut, ich weiß, was falsch ist und was mein nächster Schritt ist – eine Reihe von Beiträgen und Unterkategorien löschen. Es würde nicht durch die Verlinkung zu einer Anleitung zum “Löschen einer Kategorie” in der App verbessert werden.

Natürlich ist es immer noch eine Notlösung für das eigentliche Problem: Warum kann ich eine Kategorie mit Beiträgen darin nicht löschen? Ich kann Ordner mit Unterordnern und Dateien auf meinem System löschen, warum kann ich keine Kategorien mit Unterkategorien und Beiträgen löschen? Wenn es diese seltsamen Einschränkungen nicht gäbe, gäbe es von vornherein keinen Bedarf an einer Anleitung in der App.

Und schließlich Erklärungen – das ist es, was der Blogbeitrag “Understanding Trust Levels” ist. Als ich ihn zum ersten Mal sah, war er ziemlich verwirrend – “Ist ein zufälliger Blogbeitrag von vor 6 Jahren wirklich das Beste, was Sie als Dokumentation haben?” – und er verlinkt zu einem Referenzartikel, der alle Dinge in einer Tabelle auflistet, was eher dem entsprach, was ich erwartet hatte (wenn auch nicht in der von mir erwarteten Reihenfolge). Erklärungen helfen mir nicht direkt bei der Bewältigung einer Aufgabe, daher funktioniert es nicht gut, sie an einem Ort zu platzieren, an dem eine Aufgabe erledigt werden würde.


Ich denke, letztendlich ist Dokumentation zwar an einigen Stellen wichtig (z. B. beim Onboarding oder in Fällen, in denen das Design fehlschlägt), aber es ist wirklich das Design, das im Vordergrund stehen sollte. Das Lesen oder Ansehen eines Videos, in dem jemand Ihnen die Website erklärt, ist selten das gewünschte Erlebnis.

5 „Gefällt mir“

Ja, als ehemaliger Game-Design-Student stimme ich Ihnen von ganzem Herzen zu. (Ich erinnere mich, dass Sie Designer für Audacity sind. Übrigens benutze ich Audacity sehr oft, ich bin Ihnen sehr dankbar dafür!)

Ich denke auch, dass die gesamte Erfahrung von Grund auf neu überdacht werden könnte (beginnend mit der Überlegung: „Was möchte ein Administrator tun und wie können wir ihm am besten dabei helfen?“ für alle Anwendungsfälle), um sowohl die Prozesse besser zu vermitteln als auch die Prozesse selbst so einfach wie möglich zu gestalten.

Für das Beispiel, dass Sie eine Kategorie nicht löschen können, wenn sich Themen darin befinden – eine elegantere Handhabung durch die Software könnte so aussehen. Wenn Sie versuchen, eine Kategorie mit Themen darin zu löschen, könnte sie zuerst vorschlagen, ob Sie:

  • alle vorhandenen Themen in eine andere Kategorie verschieben möchten, oder
  • alle vorhandenen Themen in „Nicht kategorisiert“ verschieben möchten, oder
  • alle Themen in der Kategorie löschen möchten

und dann bestätigen, dass Sie die Kategorie löschen möchten.

Ich schätze, wenn man bedenkt, dass das Discourse-Team in dieser Phase auf inkrementelle Änderungen setzt:

Ich habe mich für eine einfachere Lösung eingesetzt – das Hinzufügen einiger Links zu den beliebtesten/häufigsten/wichtigsten Dokumenten, wo dies am relevantesten wäre.

(Ich werde vielleicht später ein neues Thema für das Feedback/die Vorschläge eröffnen, über die wir hier gesprochen haben, zur Verbesserung der Erfahrung beim Löschen von Kategorien.)

Ich mag diesen Vorschlag sehr – danke, dass du ihn hervorgehoben hast, @bloomexperiment! Wir arbeiten derzeit an der Verbesserung der allgemeinen Struktur und Kategorisierung unserer Dokumentation, und ich denke, diese Art von Funktion wäre es wert, in diesem Prozess berücksichtigt zu werden. Ich werde sie der Dokumentations-Roadmap als etwas zum Erkunden hinzufügen und wir werden sehen, wie sie am besten umgesetzt werden könnte.

2 „Gefällt mir“

Es tut mir leid, ein altes Thema wieder aufzugreifen, und mir ist sehr bewusst, welche Arbeit derzeit an der Admin-Suche und der Verbesserung des gesamten Admin-Erlebnisses geleistet wird. In den letzten Wochen habe ich oft daran gedacht, wie sehr ich mir wünsche, dass der Name jeder Site-Einstellung ein Link zum relevanten Dokumentationsthema auf Meta wäre. In den letzten Jahren hat sich die Meta-Dokumentation erheblich verbessert und ist jetzt recht umfassend, organisiert und informativ.

Beispiel:

Im obigen Beispiel möchte ich, dass „Backup-Speicherort“ zu einem Meta-Thema wie Configure automatic backups for Discourse verlinkt.

Könnten wir uns schrittweise einem Stadium nähern, in dem jede dieser Site-Einstellungsnamen auf den entsprechenden Meta-Thread verlinkt? Ich kann mir vorstellen, dass Sie keine URLs fest in den Discourse-Code einbetten möchten, aber ich schätze, es könnte irgendwie in den Site-Texten erfolgen.

Die Arbeit, all diese Verknüpfungen herzustellen, ist recht umfangreich, aber vielleicht wäre eine gemeinschaftliche Anstrengung über eine Reihe von Self-Hostern hinweg möglich?

3 „Gefällt mir“