Aiuto:Linee guida su come contribuire al Wiki
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
- 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>).
- 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. - 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
- 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.
- Usate, quando necessario, i vari elementi di formattazione (descrizioni, riquadro di warning, esempio ecc.): la guida risulterà più leggibile.
- 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.