Ristrutturazione della documentazione per una maggiore chiarezza

:white_check_mark: Aggiornamento (4 giugno 2024): Il lavoro iniziale di ristrutturazione degli argomenti della documentazione è stato completato e le nuove categorie sono ora attive con nuovi indici che mostrano cosa troverete al loro interno. Potete consultarli qui: Documentation - Discourse Meta - se notate qualcosa di errato, pubblicate un commento qui sotto!

Dopo un’attenta revisione della struttura attuale della nostra documentazione, siamo lieti di condividere che stiamo procedendo a migliorare la categorizzazione della documentazione per rendere gli argomenti più organizzati e focalizzati sugli obiettivi che la nostra comunità si prefigge di raggiungere. Il nostro obiettivo è migliorare la chiarezza e l’utilità della nostra documentazione, facilitando a tutti la possibilità di trovare le informazioni di cui hanno bisogno.

Cosa aspettarsi

:label: Nuove categorie

D’ora in poi, la nostra documentazione sarà categorizzata e taggata in base all’azione o alla funzionalità che descrive. Le raggruppamenti attuali basati sul ruolo dell’utente verranno abbandonati e aggiorneremo tutti gli argomenti della documentazione per indicare quale ruolo utente è necessario per svolgere le attività da essi descritte.

:eyes: Modifiche visive temporanee

Durante questa ristrutturazione, potreste notare che alcune sezioni della nostra documentazione sembrano fuori posto o disorganizzate. Non preoccupatevi! Si tratta di una situazione temporanea mentre lavoriamo per finalizzare la nuova struttura.

:white_check_mark: Aggiornamenti completi

Una volta completata la ristrutturazione, il nostro prossimo passo sarà aggiornare tutti gli argomenti della documentazione per allinearli a una nuova guida di stile comune. Correggeremo anche eventuali inesattezze presenti. Si tratterà di un progetto in corso, con la maggior parte del lavoro da svolgere nelle prossime settimane.

Come potete aiutarci

Il vostro feedback, come sempre, è per noi prezioso. Se riscontrate problemi o avete suggerimenti su come possiamo migliorare ulteriormente la nostra documentazione, non esitate a condividere le vostre idee in Contribute > Site feedback o come post in questo argomento.

Grazie per la pazienza mentre apportiamo queste modifiche!

14 Mi Piace

Gli argomenti sulla moderazione come Discourse Moderation Guide fanno parte di Documentation > Site Management. Forse questo dovrebbe essere aggiunto alla descrizione perché, come moderatore, non cercherei argomenti in una categoria per “proprietari e amministratori del sito”.

3 Mi Piace

Ho apportato una piccola modifica al testo della sezione “Informazioni” per indicare che è utile anche per i moderatori.

Anche @JammyDodger e/o @hugh potrebbero avere ulteriori pensieri quando vedranno questo in seguito.

2 Mi Piace

Ho apportato una modifica aggiuntiva:

4 Mi Piace

Grazie per averlo evidenziato @Moin!

@JammyDodger Il tuo aggiornamento mi sembra buono.

Il lavoro iniziale di ristrutturazione degli argomenti della documentazione è stato completato e le nuove categorie sono ora attive con nuovi indici che mostrano cosa troverai al loro interno.

Puoi controllarli qui: Documentation - Discourse Meta - se noti qualcosa di errato, per favore rispondi qui sotto!

1 Mi Piace

Hai intenzione di aggiungere le nuove categorie al plugin docs?

1 Mi Piace

Siamo indecisi tra provare la vita senza il plugin dei documenti o meno. :slight_smile: Per ora, ho aggiunto le nuove categorie al mix. :+1:

3 Mi Piace

Un post è stato unito a un argomento esistente: Navigazione della documentazione migliorata con una nuova barra laterale

Posso sapere come viene creato il testo dei link agli argomenti nella barra laterale quando ci si trova in una sottocategoria? IA?

1 Mi Piace

Ogni sottocategoria ha un argomento indice, ad esempio: Using Discourse Index (questi sono collegati dalla descrizione nell’intestazione di ciascuna sottocategoria).

La barra laterale prende i titoli abbreviati da lì per utilizzarli invece dei titoli completi degli articoli.

3 Mi Piace