Linee guida per i contenuti
Da Wiki di NetBSD Italia.
(Differenze fra le revisioni)
(→Formattazione) |
|||
| Riga 9: | Riga 9: | ||
#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. | #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. | ||
# [ .. ] | # [ .. ] | ||
| + | |||
| + | == Titoli == | ||
| + | # Le pagine relative a una determinata operazione (installazione, configurazione, etc.) dovrebbero avere un titolo '''chiaro''' che cominci col nome dell'argomento seguito dal testo relativo all'operazione spiegata. Esempio: [[Samba: installazione]] | ||
| + | # Gli articoli che documentano un software dalla sua installazione alla verifica della corretta configurazione dovrebbero avere un titolo comprendente '''solo''' il nome del software in questione. Nel caso in cui vengano trattati altri software in un unico articolo, utilizzare un '''+''' come separatore, ad esempio: [[Lighttpd + PHP + MySQL]]. | ||
== Formattazione == | == Formattazione == | ||
Versione delle 19:38, 4 set 2007
(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
- 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
- Note come FIXME, TODO o Xxx sono da evitare. Utilizzare piuttosto dei riferimenti mettendo le spiegazioni (anche piuttosto dettagliate) a fondo pagina.
- Evitare considerazioni personali, commenti e quant'altro non sia strettamente correlato all'articolo o di rilevante importanza per la comprensione dello stesso.
- 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.
- [ .. ]
Titoli
- Le pagine relative a una determinata operazione (installazione, configurazione, etc.) dovrebbero avere un titolo chiaro che cominci col nome dell'argomento seguito dal testo relativo all'operazione spiegata. Esempio: Samba: installazione
- Gli articoli che documentano un software dalla sua installazione alla verifica della corretta configurazione dovrebbero avere un titolo comprendente solo il nome del software in questione. Nel caso in cui vengano trattati altri software in un unico articolo, utilizzare un + come separatore, ad esempio: [[Lighttpd + PHP + MySQL]].
Formattazione
I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole:
WiP
