La documentazione di Discourse è il luogo principale in cui amministratori, moderatori, utenti e sysadmin possono trovare aiuto sull’utilizzo di Discourse e sulla gestione dei propri siti.
Sebbene questa documentazione sia robusta e copra molti aspetti, ci sono alcune aree mancanti che non abbiamo ancora documentato. Questa è una grande opportunità per la community di contribuire a perfezionare questa importante parte del progetto Discourse.
Ci piacerebbe vedere più persone coinvolte nella creazione di contenuti di documentazione per Discourse e vogliamo rendere il più semplice possibile per chiunque farlo. A tal fine, di seguito è riportato un elenco di funzionalità o casi d’uso di Discourse che abbiamo identificato come richiedenti una documentazione nuova o migliorata.
Posizioni della documentazione
Chiunque abbia un livello di fiducia 2 o superiore può creare nuovi argomenti di documentazione in Community wiki questa è la sede di tutti i contenuti di documentazione contribuiti dalla community. Se un argomento nel wiki della community è considerato rilevante o importante, può essere spostato in Documentation, la sede di tutta la documentazione ufficiale di Discourse. Puoi leggere la policy di documentazione per maggiori dettagli.
Badge per i contributori della documentazione
Chiunque crei un nuovo argomento nella categoria Community wiki riceverà automaticamente il badge di bronzo Scribe:
Se l’argomento è considerato sufficientemente valido da essere spostato nella categoria ufficiale Documentation, qualcuno del team di Discourse lo farà manualmente, attribuirà il merito all’autore originale nel contenuto dell’argomento e gli assegnerà il badge d’argento Ghostwriter:
Documentazione da scrivere
Sebbene alla fine desideriamo che ogni parte di Discourse sia documentata in modo approfondito, queste sono le aree che abbiamo identificato con la necessità più pressante (gli elementi barrati indicano argomenti che sono stati scritti da quando questo post è stato pubblicato per la prima volta):
- Un tutorial generale di avvio per gli amministratori
- Redirect di argomenti personalizzati
- Spiegazione di cosa possono fare i diversi livelli utente
- Opzioni di accesso social
- Avvisi sui post (doc ufficiale)
- Più documentazione su come funzionano i livelli di fiducia
- Come scrivere una buona richiesta di funzionalità per Discourse (argomento wiki)
- Un riferimento su come appaiono le funzionalità di markdown e formattazione di Discourse quando incluse nelle email
- Stati utente (argomento wiki)
- Spiegazione della modalità scura, come selezionarla e come abilitare il passaggio (argomento wiki)
- Documentazione generale che copre la gestione delle preferenze utente (argomento wiki)
- Documenti che spiegano come funzionano le categorie e la gerarchia in Discourse
- Una guida generale per le impostazioni degli argomenti
- Una guida generale sui plugin: cosa sono, come funzionano e come usarli
- Pagine iniziali personalizzate
- Modifica delle categorie e degli argomenti predefiniti
- Utilizzo di griglie di immagini nei post (argomento wiki)
- Impostazioni di approvazione dei post (argomento wiki)
Alcuni di questi potrebbero richiedere più argomenti per essere documentati efficacemente.
Come scrivere la documentazione
Per garantire che la documentazione di Discourse sia il più efficace possibile, abbiamo una guida di stile su come scrivere questi contenuti. Sebbene sarebbe utile che tutti seguissero la guida, se stai contribuendo a Community wiki, non è un problema se non la segui completamente. Qualsiasi argomento che viene spostato in Documentation verrà aggiornato dallo staff di Discourse per corrispondere alla guida di stile secondo necessità.
Interessato?
Entra in Community wiki e inizia a documentare oggi stesso. Se vuoi discutere di qualcosa, sentiti libero di rispondere a questo argomento per parlarne.

