HOW TOs - Amministrazione Sistemi Mageia

Questa pagina è in sola lettura. Puoi visualizzare il sorgente, ma non puoi modificarlo. Contatta l'amministratore se pensi che ci sia un errore.
====== Convenzioni di scrittura ======

Dal momento che il wiki è un'applicazione dedicata alla collaborazione finalizzata a produrre, nel nostro caso, documentazione, è importante che questa collaborazione sia regolata per evitare confusione e la conseguente scarsa fruibilità dei contenuti che andiamo a creare.

Per questa ragione abbiamo definito alcune convenzioni cui attenersi durante la stesura di ogni guida.

===== Struttura delle guide =====

<file>
====== Titolo Principale della Guida ======

^            Titolo principale della guida   ^^
^ Autore  | Nome (nickname)                   |
^ Data    | gg/mm/aaaa hh:mm                  |
^ Livello | * * * * *                         |

===== Premessa/Introduzione =====

bla bla bla

===== fase X (es. Download requisiti) =====

bla bla bla

===== fase X+1 (es. Installazione) =====

bla bla bla

===== fase X+2 (es. Configurazione) =====

bla bla bla

===== fase X+n (tutte le sezioni necessarie, senza esagerare) =====

es. Workaround, Suggerimenti e trucchi, ecc.

===== Riferimenti/Bibliografia =====

  * Link a riferimento 1
  * Link a riferimento 2
  * ecc
</file>

**Titolo della guida**: deve essere breve e significativo, formattato come H1

**Tabella riassuntiva**: come da esempio
  * //Nota//: il **livello** va espresso con un numero di asterischi compreso tra 1 e 5; 5 asterischi rappresentano il livello di difficoltà massimo, 1 il livello di difficoltà minimo;

**Introduzione**: premessa o preambolo, inquadramento generale dell'argomento trattato; titolo sezione formattato H2.

**Fasi della guida**: es. installazione e configurazione requisiti, installazione applicativo in questione, configurazione applicativo in questione, uso, conclusioni; titoli delle sezioni da H2 a H4 evitare profondità maggiori se possibile.