Linee guida per i contenuti

Da Wiki di NetBSD Italia.

Versione delle 21:48, 4 set 2007

(a.k.a. linee guida per i contenuti)

L'intento di questa pagina è quello di stabilire dei criteri per l'organizzazione dei documenti all'interno del Wiki cercando di collocarli nelle giuste categorie e, qualora fosse necessario, creandone di nuove secondo i criteri qui descritti.

Regole generali

1. Le pagine non devono essere firmate: il nome di chi ha creato l'articolo i di chi ha, eventualmente, contribuito non và incluso a meno che non sia pertinente all'argomento
2. Note come FIXME, TODO o Xxx sono da evitare. Utilizzare piuttosto dei riferimenti mettendo le spiegazioni (anche piuttosto dettagliate) a fondo pagina.
3. Evitare considerazioni personali, commenti e quant'altro non sia strettamente correlato all'articolo o di rilevante importanza per la comprensione dello stesso.
4. Qualora la dimensione del testo richiesto per la creazione di un articolo sia inferiore a una pagina completa, è opportuno optare per l'inclusione di una nuova FAQ piuttosto che di un nuovo articolo.

Scelta del titolo

1. Le pagine relative a una determinata operazione (installazione, configurazione, etc.) dovrebbero avere un titolo chiaro che riassuma esattamente l'argomento trattao, ad esempio: Installazione di Samba, Installazione di Xorg modulare, etc.
2. Gli articoli che documentano un software partendo dalla sua installazione e concludendo con la verifica della corretta configurazione , elencando eventualmente alcune soluzione per la risoluzione di problemi comuni, dovrebbero avere un titolo che inizi col testo Messa appunto di/del seguito dal nome del software in questione. Nel caso in cui vengano trattati altri software in un unico articolo utilizzare un + come separatore, ad esempio: [[Messa a punto di Lighttpd + PHP + MySQL]].
3. Il titolo di un articolo avente un tono conversativo non troppo formale può essere arbitrario, purchè sia quanto più descrittivo possibile. Un esempio ben scritto di questo genere di articoli (da utilizzare come unità di riferimento) è Primi passi con NetBSD.

Formattazione

I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole:

Note

In alcune circostanze può risultare necessario l'inserimento di alcune note al fine di sottolineare alcuni concetti di rilevante importanza nel contesto in cui ci si trova. In questi è sufficiente far precedere il testo della nota dalla parola NOTA formattata in grasseto seguita dal simbolo : (due punti) senza formattazione e dal testo della nota. Esempio:

NOTA: questa è una nota

Sono da evitare note come la seguente:

NOTA: questa è una nota

In quanto questo genere di formattazione è riservato ad altre tipologie di testo.