Linee guida per i contenuti
Da Wiki di NetBSD Italia.
Versione delle 22:01, 3 ago 2007, autore: Clamiax (Discussione | contributi)
(a.k.a. linee guida)
L'intento di questa pagina è quello di stabilire dei criteri per l'organizzazione dei documenti (presenti e futuri) 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.
- Cos'altro?
Contributo comunità
Tutti i documenti devono appartenere almeno ad una alle seguenti categorie:
- Tutorial: tutti i documenti che spieghino come realizzare una determinata operazione introducendo i concetti chiave di argomenti correlati necessari per la completa comprensione dell'argomento trattato.
- How to: tutti i documenti che illustrino procedure rapide per la messa a punto, l'installazione, la configurazione, l'hack o quant'altro sia inerente a un software specifico o a un gruppo di software senza soffermarsi troppo sui dettagli legati ad argomenti esterni, implementazioni e architetture specifiche.
Formattazione
I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti categorie:
WiP