Linee guida per i contenuti

Da Wiki di NetBSD Italia.

(Differenze fra le revisioni)
(Documenti ufficiali)
Riga 2: Riga 2:
== Documenti ufficiali ==
== Documenti ufficiali ==
-
L'indice di ogni documento ufficiale '''deve essere''' una categoria, come ad esempio la [[:Categoria:Guida di NetBSD|Guida di NetBSD]]. Per ogni sotto sezione, ad esempio [[:Categoria:NetBSD RAIDframe|'''15.''' NetBSD RAIDframe]], si crea una categoria con lo stesso nome della sezione, includendo all'interno di questa categoria tutti gli elementi contenuti nella sezione in questione. In questo modo ogni capitolo appartiene '''sempre''' almeno a 2 categoria: la categoria primaria, (in questo caso ''Guida di NetBSD'') e quella che prende il nome della sezione principale all'interno del quale il capitolo è contenuto. Quindi considerando l'esempio precedente tutti i paragrafi di ogni capitolo apparterranno '''almeno''' a '''2''' categorie: ''Guida di NetBSD'' e ''NetBSD RAIDframe''. Per ogni sotto sezione verrà creato un nuoto articolo appartenente alle suddette cagetorie in modo tale da rendere accessibile e indipendente al massimo ogni porzione di documentazione aumentandone la facilità di consultazione e la semplicita nelle ricerche.
+
L'indice di ogni documento proveniente da fonti ufficiali '''deve essere''' una categoria, come ad esempio la [[:Categoria:Guida di NetBSD|Guida di NetBSD]]. Per ogni sotto sezione, ad esempio [[:Categoria:NetBSD RAIDframe|'''15.''' NetBSD RAIDframe]], si crea una categoria con lo stesso nome della sezione, includendo all'interno di questa categoria tutti gli elementi contenuti nella sezione in questione. In questo modo ogni capitolo appartiene '''sempre''' almeno a 2 categoria: la categoria primaria, (in questo caso ''Guida di NetBSD'') e quella che prende il nome della sezione principale all'interno del quale il capitolo è contenuto. Quindi considerando l'esempio precedente tutti i paragrafi di ogni capitolo apparterranno '''almeno''' a '''2''' categorie: ''Guida di NetBSD'' e ''NetBSD RAIDframe''. Per ogni sotto sezione verrà creato un nuoto articolo appartenente alle suddette cagetorie in modo tale da rendere accessibile e indipendente al massimo ogni porzione di documentazione aumentandone la facilità di consultazione e la semplicita nelle ricerche.
-
'''WiP...'''
+
== Contributo comunità ==
 +
Tutti i documenti provenienti da fonti '''non''' ufficiali devono appartenere almeno ad una alle seguenti categorie:
 +
 
 +
* [[:Categoria:Tutorial]]: tutti i documenti che spieghino come realizzare una determinata operazione introducendo i concetti chiave di argomenti correlati necessari per una completa comprensione dell'argomento trattato.
 +
* [[:Categoria:Howto]]: tutti i documenti ''rapidi'' che illustrino procedure per la messa a punto, l'installazione, la configurazione, l'hack o quant'altro sia inerente a un software sepcifico o a un gruppo di software senza soffermarsi troppo sui dettagli legati ad argomenti esterni

Versione delle 20:41, 28 lug 2007

L'intendo 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.

Documenti ufficiali

L'indice di ogni documento proveniente da fonti ufficiali deve essere una categoria, come ad esempio la Guida di NetBSD. Per ogni sotto sezione, ad esempio 15. NetBSD RAIDframe, si crea una categoria con lo stesso nome della sezione, includendo all'interno di questa categoria tutti gli elementi contenuti nella sezione in questione. In questo modo ogni capitolo appartiene sempre almeno a 2 categoria: la categoria primaria, (in questo caso Guida di NetBSD) e quella che prende il nome della sezione principale all'interno del quale il capitolo è contenuto. Quindi considerando l'esempio precedente tutti i paragrafi di ogni capitolo apparterranno almeno a 2 categorie: Guida di NetBSD e NetBSD RAIDframe. Per ogni sotto sezione verrà creato un nuoto articolo appartenente alle suddette cagetorie in modo tale da rendere accessibile e indipendente al massimo ogni porzione di documentazione aumentandone la facilità di consultazione e la semplicita nelle ricerche.

Contributo comunità

Tutti i documenti provenienti da fonti non ufficiali devono appartenere almeno ad una alle seguenti categorie:

  • Categoria:Tutorial: tutti i documenti che spieghino come realizzare una determinata operazione introducendo i concetti chiave di argomenti correlati necessari per una completa comprensione dell'argomento trattato.
  • Categoria:Howto: tutti i documenti rapidi che illustrino procedure per la messa a punto, l'installazione, la configurazione, l'hack o quant'altro sia inerente a un software sepcifico o a un gruppo di software senza soffermarsi troppo sui dettagli legati ad argomenti esterni
Strumenti personali