La documentazione di Discourse è il luogo principale in cui amministratori, moderatori, utenti e sysadmin possono trovare aiuto per utilizzare Discourse e gestire i propri siti.
Sebbene questa documentazione sia robusta e copra molti aspetti, ci sono alcune aree mancanti che non abbiamo ancora documentato. Questa è un’ottima opportunità per la comunità di coinvolgersi e aiutare a perfezionare questa parte importante del progetto Discourse.
Ci piacerebbe vedere più persone coinvolte nella creazione di contenuti documentali 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 bisognosi di nuova o migliorata documentazione.
Posizioni della documentazione
Chiunque abbia un livello di fiducia 2 o superiore può creare nuovi argomenti di documentazione in Wiki questa è la sede per tutti i contenuti della documentazione contribuiti dalla comunità. Se un argomento nella wiki della comunità è considerato rilevante o importante, può essere spostato in Documentation la sede per tutta la documentazione ufficiale di Discourse. Puoi leggere la politica sulla documentazione per maggiori dettagli a riguardo.
Badge per i contributori della documentazione
Chiunque crei un nuovo argomento nella categoria Wiki riceverà automaticamente il badge bronzo Scribe:
Se l’argomento è considerato abbastanza prezioso da essere spostato nella categoria ufficiale Documentation, qualcuno del team di Discourse lo farà manualmente, accreditando l’autore originale nel contenuto dell’argomento e assegnando loro il badge argento Ghostwriter:
Documentazione che deve essere scritta
Sebbene vogliamo in ultima analisi vedere ogni parte di Discourse completamente documentata, queste sono le aree che abbiamo identificato come aventi 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 per l’avvio per gli amministratori
- Reindirizzamenti personalizzati degli argomenti
- Spiegazione di cosa possono fare i diversi livelli utente
- Opzioni di accesso sociale
- Avvisi dei messaggi (documentazione ufficiale)
- Maggiore 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à markdown e di formattazione di Discourse quando incluse nelle email
- Stati utente (argomento wiki)
- Spiegazione della modalità scura, come selezionarla e come abilitare il cambio (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 alle impostazioni degli argomenti
- Una guida generale sui plugin: cosa sono, come funzionano e come usarli
- Homepage personalizzate
- Modifica delle categorie predefinite e degli argomenti
- Utilizzo delle griglie di immagini nei messaggi (argomento wiki)
- Impostazioni di approvazione dei messaggi (argomento wiki)
Alcuni di questi potrebbero richiedere più argomenti per essere documentati in modo efficace.
Come scrivere la documentazione
Per garantire che la documentazione di Discourse sia il più efficace possibile, abbiamo una guida di stile su come scrivere questo contenuto. Sebbene sarebbe utile per tutti seguire la guida, se stai contribuendo a Wiki, non è un problema se non la segui completamente. Qualsiasi argomento spostato in Documentation verrà aggiornato dallo staff di Discourse per corrispondere alla guida di stile, se necessario.
Interessato?
Entra in Wiki e inizia a documentare oggi stesso. Se vuoi discutere di qualsiasi cosa, sentiti libero di rispondere a questo argomento per parlarne.

