Recentemente, ci siamo impegnati a migliorare la nostra documentazione qui su meta, con l’obiettivo di categorizzare le cose in modo che utenti diversi possano trovare argomenti pertinenti per loro e ignorare quelli che non lo sono.
Miriamo ad avere tutta la documentazione in una delle seguenti categorie:
- #documentation:users - uso generale comune
- #documentation:moderators - moderazione di una community
- #documentation:theme-developers - sviluppo di temi e componenti di temi
- #documentation:admins - amministrazione di un sito Discourse
- #documentation:devs - sviluppo di funzionalità, plugin e integrazioni di Discourse
- #documentation:sysadmin - amministrazione di sistema self-hosted
Abbiamo in programma di rimuovere #documentation:faq e #documentation:tips-and-tricks alla fine di questo (ma abbiamo iniziato a taggare alcuni argomenti nelle nuove categorie con #tips-and-tricks).
Miriamo anche a taggare la documentazione con uno di questi tag di classificazione presi in prestito da divio per questo post precedente:
Le cose non sempre si adattano perfettamente. In alcuni casi, stiamo dividendo gli argomenti e in altri stiamo semplicemente usando il tag o la categoria che si adatta meglio al suo stato attuale.
Alcune modifiche comuni che abbiamo apportato finora ai singoli argomenti (siamo circa al 50% del lavoro).
- Spostamento di elementi da #documentation:admins a #documentation:sysadmin quando richiedono l’accesso alla console.
- Suddivisione degli argomenti di #documentation:faq in argomenti per #documentation:admins e argomenti per #documentation:users.
- Spostamento di argomenti da #documentation:devs a #documentation:theme-developers quando sono specifici per lo sviluppo di temi o componenti di temi.
- Aggiornamento dei titoli degli argomenti per renderli più coerenti
- Utilizzo del tempo imperativo per i titoli degli argomenti (e rimozione di “how to” dal titolo).
- Utilizzo della capitalizzazione normale delle frasi
- Formattazione dei contenuti con intestazioni a partire da H2
(Correlato: abbiamo anche abilitato la Tabella dei Contenuti per tutti gli argomenti di documentazione)
In alcuni casi, stiamo apportando alcune modifiche al contenuto stesso, ma approfondire non è il nostro obiettivo immediato. In un passaggio futuro, vorremmo fare cose come:
- Incorporare il contenuto delle risposte nella documentazione stessa
- Eliminare tutte le risposte
- Configurare gli argomenti per eliminare le risposte dopo 1 o 2 mesi
Quindi, in futuro, forniremo indicazioni aggiornate su come contribuire con nuova documentazione e mantenere la documentazione esistente e aggiorneremo i seguenti argomenti:
Potremmo voler rendere più argomenti Wiki o trovare nuovi proprietari per la documentazione quando viene mantenuta da qualcuno diverso dall’autore originale, ad esempio.
Pensiamo anche che ci possa essere un’opportunità qui per creare uno o più spazi separati per consentire alle persone di fare più “mostra e racconta” sulla falsariga di alcuni dei contenuti che erano in #documentation:tips-and-tricks. Creare spazio per argomenti come questi al di fuori della documentazione potrebbe consentire più spazio per discuterne tra pari. Ma, analogamente a quanto stiamo facendo ora con la documentazione, forse sarebbe utile avere spazi separati per amministratori di sistema, amministratori e sviluppatori per tali discussioni. Cosa ne pensi?