Includi più suggerimenti durante tutto Discourse che collegano ai documenti pertinenti su Meta

Contesto

Il team di Discourse ha menzionato in diversi luoghi che sta cercando di migliorare l’esperienza dell’amministratore.

Problema

Ci sono molte impostazioni in Discourse e molta documentazione. Ma è improbabile che tu trovi la documentazione giusta al momento giusto.

Funzionalità

Potrebbero esserci molti più posti nelle impostazioni e nei menu di Discourse in cui viene collegata la documentazione corrispondente su \u003chttps://meta.discourse.org/docs\u003e.

Ad esempio, c’è il post del blog Understanding Discourse Trust Levels che è collegato nelle installazioni di Discourse.

Ma ce ne sono molti altri che non lo sono.

Ad esempio, c’è una guida su come eliminare una categoria.

Sembra che sarebbe rilevante/utile includerlo nella finestra modale dove puoi vedere il pulsante per eliminare le categorie.

Potrebbe essere un link, ma non deve essere solo un link per ogni caso – potrebbe essere un pulsante a forma di punto interrogativo che rimanda alla documentazione, o potrebbe essere “Leggi di più…” ecc.

Il team di Discourse potrebbe sfogliare la documentazione, iniziando da quelle principali, e capire dove nel software sarebbe il posto più pertinente per collegare quella documentazione.

(Ovvero “just in time”)

Altri esempi di software

Ghost (un software di blogging open source) ha un paio di posti in cui la sua documentazione è collegata, proprio quando ne hai bisogno.

Ad esempio, questo pulsante “Scopri di più” rimanda alla documentazione pertinente:

Lo stesso vale qui:

Non ero sicuro se questo rientrasse in Feature o UX, sentiti libero di spostarlo.

5 Mi Piace

Dovrei dissentire leggermente. Ci sono diverse tipologie di contenuti di aiuto che puoi creare. Se seguiamo il modello Diátaxis, si tratta di tutorial, guide pratiche, riferimenti e spiegazioni.

I tutorial probabilmente hanno un posto dove essere collegati nell’app stessa, in modo tale che se entri in una pagina con l’intento “Voglio imparare come funziona”, puoi impararlo, anche se la pagina non è autoesplicativa. Forse anche un centro tutorial che ti permette essenzialmente di completare un corso sul software, se lo desideri.

Le altre 3 categorie mi creano qualche problema.

Se vado alla pagina delle impostazioni delle categorie, potrebbero esserci 20 cose diverse che vorrei fare. Mettere una guida pratica lì risulterebbe in un elenco da cercare e, poiché ho l’aspettativa che ciò che sto cercando non abbia necessariamente un articolo dedicato, probabilmente digiterò quella domanda su Google invece di cercare nell’elenco.

I riferimenti esterni sono un flagello con cui ho a che fare quotidianamente. Abbiamo un “manuale di riferimento” che ti dice cosa fa ogni cursore e pulsante, fino a:

Pulsante Annulla: Chiude la finestra di dialogo senza applicare le modifiche
Pulsante OK: Chiude la finestra di dialogo, applicando le modifiche

Usare questo riferimento significa dover scorrere molto materiale tecnico prima di arrivare alla tua sezione, quando ciò di cui avevi veramente bisogno era un tooltip che riformulasse un’opzione con poche parole in più.

Se provo a eliminare una categoria, il comportamento attuale è quasi desiderabile. Vedo il pulsante, solitamente disattivato ma con un punto interrogativo, e se ci clicco sopra, dice:

Impossibile eliminare questa categoria perché contiene sottocategorie.

o:

Impossibile eliminare questa categoria perché contiene 25852 argomenti. L’argomento più vecchio è…

Il comportamento è buono, so cosa c’è di sbagliato e qual è il mio prossimo passo: eliminare un mucchio di post e sottocategorie. Non migliorerebbe collegandosi alla guida pratica “eliminare una categoria” invece.

Naturalmente, è ancora una soluzione temporanea al problema reale: Perché non mi permette di eliminare una categoria con post al suo interno? Posso eliminare cartelle con sottocartelle e file sul mio sistema, perché non posso eliminare categorie con sottocategorie e post? Se non avesse queste strane restrizioni, non ci sarebbe nemmeno bisogno di una guida pratica nell’app.

E infine, le spiegazioni: questo è ciò che è il post del blog “comprendere i livelli di fiducia”. Quando l’ho incontrato per la prima volta, è stato piuttosto confusionario: “un post casuale di 6 anni fa è davvero il meglio che avete come documentazione?” - e si collega a un articolo di riferimento che elenca tutte le cose in una tabella, che era più in linea con quello che mi aspettavo (anche se non ordinato nel modo in cui mi aspettavo). Le spiegazioni non mi aiutano a capire direttamente un’attività, quindi metterle in un posto dove verrebbe completata un’attività non funziona molto bene.


Penso che, in definitiva, mentre la documentazione è importante in alcuni luoghi (ad esempio, l’onboarding, o in casi in cui il design fallisce), è davvero il design che dovrebbe essere il focus principale. Leggere o guardare un video in cui qualcuno ti spiega il sito web raramente è l’esperienza desiderata.

5 Mi Piace

Sì, come ex studente di game design, sono completamente d’accordo con te. (Ricordo che sei uno sviluppatore di Audacity. A proposito, uso molto Audacity, ti sono molto grato!)

Penso anche che l’intera esperienza potrebbe essere ripensata da zero (iniziando pensando: “cosa vorrebbe fare un amministratore e come possiamo aiutarlo al meglio a farlo?” per tutti i casi d’uso) per trasmettere meglio i processi e rendere i processi stessi il più semplici possibile.

Per l’esempio di non consentire l’eliminazione di una categoria se ci sono argomenti al suo interno, un modo più elegante in cui il software potrebbe gestirlo sarebbe questo. Quando si tenta di eliminare una categoria con argomenti al suo interno, potrebbe prima suggerire se si desidera:

  • spostare tutti gli argomenti esistenti in un’altra categoria, o
  • mettere tutti gli argomenti esistenti in Non categorizzato, o
  • eliminare tutti gli argomenti nella categoria

e quindi confermare che si desidera eliminare la categoria.

Suppongo che vedendo che il team di Discourse stava puntando a cambiamenti più incrementali in questa fase:

Stavo chiedendo un obiettivo più facile da raggiungere: aggiungere alcuni collegamenti alla documentazione più popolare/comune/importante dove sarebbe più pertinente.

(Potrei anche creare un nuovo argomento più tardi per i feedback/suggerimenti di cui abbiamo parlato qui, sul miglioramento dell’esperienza di eliminazione delle categorie.)

Mi piace molto questo suggerimento, grazie per averlo evidenziato, @bloomexperiment! Attualmente stiamo lavorando per migliorare la struttura generale e la categorizzazione della nostra documentazione, e penso che questo tipo di funzionalità varrebbe la pena di essere presa in considerazione come parte di quel processo. Lo aggiungerò alla roadmap della documentazione come qualcosa da esplorare e vedremo come potrebbe essere implementato al meglio.

2 Mi Piace

Mi dispiace riaprire un vecchio argomento, e sono molto consapevole del lavoro attuale che si sta svolgendo riguardo alla ricerca dell’amministratore e al miglioramento dell’esperienza generale dell’amministratore. Molte volte nelle ultime settimane ho pensato quanto vorrei che il nome di ogni impostazione del sito fosse un link all’argomento di documentazione pertinente su Meta. Negli ultimi anni la documentazione di Meta è migliorata enormemente, ed è ora abbastanza completa, organizzata e informativa.

Esempio:

Nell’esempio sopra vorrei che “Backup location” rimandasse a un argomento di Meta come Configure automatic backups for Discourse

Potremmo gradualmente avvicinarci a uno stadio in cui ciascuno di questi nomi di impostazioni del sito rimandi al thread Meta pertinente? Posso capire che potreste non voler codificare URL nel codice di Discourse, ma immagino che potrebbe essere in qualche modo nei testi del sito.

Il lavoro per fare tutti questi collegamenti è piuttosto grande, ma forse uno sforzo crowd-sourced tra un certo numero di self-hoster sarebbe possibile?

3 Mi Piace