Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

--- convenzioni_di_scrittura [2012/05/28 16:45] – creata xquiet
+++ convenzioni_di_scrittura [2019/01/27 10:37] (versione attuale) – modifica esterna 127.0.0.1
@@ Linea 8: / Linea 8: @@
 <file>
-Titolo della guida H1
+====== Titolo Principale della Guida ======
-Autore
+^            Titolo principale della guida   ^^
-Collaboratori (eventuali, indicati con Nome e Cognome di ognuno, separati da virgola)
+^ Autore  | Nome (nickname)                   |
+^ Data    | gg/mm/aaaa hh:mm                  |
+^ Livello | * * * * *                         |
-Introduzione H2
+===== Premessa/Introduzione =====
-Requisiti (se necessari) H2
+bla bla bla
-Contenuto
+===== fase X (es. Download requisiti) =====
-Bibliografia e/o riferimenti (se non è tutta farina del vostro sacco) H2
+bla bla bla
-</file>
-Titolo della guida: deve essere breve e significativo, formattato come H1
+===== 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>
-Autore: deve essere inserito premendo l'ultimo pulsante a destra nella barra degli strumenti
+**Titolo della guida**: deve essere breve e significativo, formattato come H1
-Collaboratori: vanno inseriti i nomi e cognomi di ogni collaboratore, tutti separati da virgola. Formattazione del testo in corsivo
+**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.
+**Introduzione**: premessa o preambolo, inquadramento generale dell'argomento trattato; titolo sezione formattato H2.
-Requisiti: requisiti fondamentali per poter seguire e comprendere la guida.
+**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.