Aiuto:Linee guida su come contribuire al Wiki

Attenzione: questo articolo è ancora incompleto e in fase di scrittura da parte del suo autore. Sentitevi liberi di contribuire, proponendo modifiche alla guida tramite l'apposita pagina di discussione, in modo da non interferire con il lavoro portato avanti sulla voce. Per altre informazioni si rimanda al template.

Linee guida su come contribuire al Wiki

Sommario

Prima di iniziare Creare e modificare una pagina Spostare e cancellare una pagina Discussioni Cronologia Sintassi Categorie I template Segnalazione dei problemi Licenze Varie Scheletro/modello di una nuova guida

Convenzioni

Ci sono delle semplici convenzioni da rispettare in modo che il contenuto del Wiki cresca in maniera omogenea e quindi più facile da leggere, per tutti.

Versioni compatibili

Inserite, all'inizio di ogni guida, il template Versioni compatibili, che permette di capire immediatamente a quali versioni di Debian fa riferimento la guida in oggetto. Per le istruzioni specifiche su come inserire questo template si veda la pagina Usare i Template.

Categorie

Ciascuna guida deve far parte di una o più categorie per essere indicizzata e permetterne una più facile ricerca e individuazione. Ricordarsi pertanto di inserire, in fondo alla guida, il tag [[Categoria: nome_della_categoria]] per ciascuna categoria di cui la guida andrà a far parte.

Convenzioni sulla sintassi

1. Tutte le volte che riportate l'output di un comando, un pezzo di un file di configurazione, o in genere dei dati ASCII, racchiudeteli in un riquadro (racchiudendo tra <pre> e </pre>).
2. Se riportate un comando usate come primo carattere $ se il comando deve essere lanciato da utente normale e # se il comando deve essere lanciato da root. Lasciate anche uno spazio dopo questo carattere, in modo che il comando non risulti attaccato al $ o # e quindi poco leggibile.
3. Quando dovete inserire all'interno del corpo del testo i seguenti elementi:
   • percorsi di file o cartelle;
   • nomi di file;
   • comandi, opzioni di comandi, singole stringhe e/o direttive dei file di configurazione;

racchiudeteli tra i tag <code> e </code>.

Convenzioni sullo stile

1. Dividete in maniera logica la guida in sezioni, sottosezioni (e, se necessario sotto-sottosezioni). In questo modo si sfrutterà meglio la potenza di MediaWiki che creerà automaticamente un indice iniziale che renderà molto più facile la navigazione nella vostra guida.
2. Usate, quando necessario, i vari elementi di formattazione (descrizioni, riquadro di warning, esempio ecc.): la guida risulterà più leggibile.
3. Cercate di rendere leggibile e pulito il codice della pagina, evitando ad esempio di lasciare tante righe vuote consecutive.

Interconnessione dei contenuti

Cercate il più possibile di inserire link ad altre pagine del Wiki, in modo da aumentare le interconnessioni, rendere più facile la ricerca delle informazioni ed evitare inutili ripetizioni in più di una guida..
Non è necessario che le pagine verso cui si creano i link debbano esistere (in questo caso il link resterà di colore rosso); la loro creazione può essere successiva da parte dello stesso autore o di altri. In entrambi i casi la presenza di link ad altri contenuti del Wiki renderà la guida stessa più completa e leggibile.

Evoluzione delle guide

Le guide su seguono un percorso (idealmente) simile a quello seguito dai pacchetti Debian nelle tre distribuzioni. Si distinguono infatti tre fasi per una guida:

• Stub: una guida è in questo stato se è ancora incompleta. Queste guide sono caratterizzate dal seguente box iniziale.

• Guida completa: la guida è ragionevolmente completa e può essere usata per conoscere nuovi argomenti. Le guide di questo tipo non hanno nessun segno particolare. Le guide complete sono state terminate dall'autore iniziale e cercano una sorta di testing da parte della comunità.

• Guida Debianized: è il terzo e ultimo livello raggiungibile da una guida sul Wiki. Una guida di questo tipo ha raggiunto la sua piena maturità essendo stata verificata e corretta anche da più di una persona nella community. Nell'indice le guide Debianized sono facilmente individuabili da una swirl: . Tutte le guide sul Wiki possono diventare Debianized una volta ricevuto un sufficiente feedback dalla comunità.

Se leggi una guida e verifichi la sua correttezza, utilizza per favore il template Autori in modo da tenere traccia della maturità della guida.

Con questi piccoli accorgimenti che richiedono un piccolo aiuto da parte della community, speriamo di poter tracciare e mantenere lo "stato di salute" delle guide, sperando che un numero sempre maggiore di esse diventi Debianized ;-).

Pagine protette

Alcune pagine del wiki sono protette, cioè un normale utente non può modificarle anche se registrato. Le pagine protette sono pagine di presentazione del progetto, pagine di licenza o pagine tecniche del Wiki. In nessun caso un articolo di documentazione riguardate Debian GNU/Linux verrà resa protetta. Se trovate una pagina di documentazione protetta, per favore, segnalatelo agli amministratori.