Linee guida per i contenuti

Da Wiki di NetBSD Italia.

(a.k.a. linee guida)

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.
5. [ .. ]

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]].

Formattazione

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

WiP