Linee guida per i contenuti

Da Wiki di NetBSD Italia.

(a.k.a. linee guida per i contenuti)

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.

Indice

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.
  • Considerazioni personali, commenti e quant'altro non sia strettamente correlato all'articolo o di rilevante importanza per la comprensione dello stesso è decisamente da evitare.
  • 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.
  • Utilizzare il testo '''WiP''' (Work in Progress) per marcare una sezione come incompleta.

Scelta del titolo

  1. 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.
  2. 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]].
  3. Il titolo di un articolo avente un tono conversativo non troppo formale può essere arbitrario, purchè sia quanto più descrittivo possibile. Un esempio ben scritto di questo genere di articoli (da utilizzare come unità di riferimento) è Primi passi con NetBSD.

Formattazione

I documenti devono essere formattati secondo criteri ben precisi, rappresentati dalle seguenti regole:

Comandi

I comandi da eseguire su una shell, dal momento che sono la parte fondamentale di una procedura, è opportuno che vengano messi in risalto secondo dei criteri ben brecisi.

  • Il comando deve iniziare con uno dei seguenti simboli
    • cancelletto, #: se per funzionare correttamente necessità i privilegi dell'amministratore di sistema;
    • dollaro, $: se può essere eseguito da utente non privilegiato.
  • Il comando dev'essere formattato in base alle regole di MediaWiki che prevedono l'inserimento di uno spazio a inizio riga in modo da incorniciare il testo successivo.
  • I comandi d'esempio devono fare esattamente il minimo indispensabile per ottenere i risultati richiesti. Flag verbose come -v di pkg_add(1) o di tar(1) non vanno utilizzate.

Esempi

Questo è un comando che non richiede i privilegi d'amministratore:

$ comando --flag argomento argomentoN..

Questo è un comando che richiede i privilegi d'amministratore:

# comando --flag argomento argomentoN..

In caso di dubbi utilizzare il simbolo cancelletto (#) al fine di evitare errori relativi permessi. Tuttavia, è buona norma evitare, se possibile, l'utilizzo di tale simbolo qualora non fosse strettamente necessario.

Note

In determinate circostanze può risultare necessario l'inserimento di alcune note al fine di sottolineare dei concetti di rilevante importanza nel contesto in cui ci si trova. In questi casi è sufficiente far precedere il testo della nota dalla parola NOTA formattata in grassetto e seguita dal simbolo : (due punti) e dal testo della nota senza alcuna formattazione. Esempio:

NOTA: questa è una nota

Sono da evitare note come la seguente:

NOTA: questa è una nota da evitare

In quanto questo genere di formattazione è riservato ad altre tipologie di testo (vedi la sezione comandi).

Strumenti personali