Linee guida per i contenuti

Da Wiki di NetBSD Italia.

Versione delle 10:39, 1 ago 2007

(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

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. Cos'altro?

Documenti ufficiali

La documentazione tradotta da fonti ufficiali deve sempre appartenere alla categoria Categoria:Documenti ufficiali, la quale appunto racchiude tutti gli articoli prelevati direttamente dal sito web ufficiale del progetto NetBSD i quali sono canditati a diventare le future traduzioni ufficiali (quindi pubblicate su NetBSD.org) della comunità, dopo essere state dettagliatamente controllate, revisionate ed approvate dalla Fondazione NetBSD.

Contributo comunità

Tutti i documenti provenienti da fonti non ufficiali 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