Linee guida per i contenuti
Da Wiki di NetBSD Italia.
(Differenze fra le revisioni)
(→Scelta del titolo) |
|||
| Riga 7: | Riga 7: | ||
# Note come '''FIXME''', '''TODO''' o '''Xxx''' sono da evitare. Utilizzare piuttosto dei [[TODO#Template|riferimenti]] mettendo le spiegazioni (anche piuttosto dettagliate) a fondo pagina. | # Note come '''FIXME''', '''TODO''' o '''Xxx''' sono da evitare. Utilizzare piuttosto dei [[TODO#Template|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. | # 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. | + | # 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 == | == Scelta del titolo == | ||
# 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. | # 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. | ||
# 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]]. | # 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]]. | ||
| + | # Qualora un determinato documento fosse realizzato in modo non troppo formale (sia a livello di impostazione che di terminologia) con consigli, considerazioni personali (da evitare, vedi [[#Regole generali]]), citazioni da fonti sconosciute, etc. il titolo può assumere un nome arbitrario, purchè sia quanto più descrittivo possibile. | ||
== Formattazione == | == Formattazione == | ||
I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole: | I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole: | ||
| + | |||
'''WiP''' | '''WiP''' | ||
Versione delle 21:23, 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.
Scelta del titolo
- 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.
- 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]].
- Qualora un determinato documento fosse realizzato in modo non troppo formale (sia a livello di impostazione che di terminologia) con consigli, considerazioni personali (da evitare, vedi #Regole generali), citazioni da fonti sconosciute, etc. il titolo può assumere un nome arbitrario, purchè sia quanto più descrittivo possibile.
Formattazione
I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole:
WiP
