Linee guida per i redattori
Tutte le pagine, i contributi e le modifiche nei Manuali devono seguire le seguenti
linee guida. Aggiornamenti ai Manuali inviati per la moderazione non saranno
pubblicati se non seguono queste linee guida. I numeri sulla sinistra sono
per referenza.
1. Titoli | |
1a | Usate titoli brevi e descrittivi per identificare una voce di manuale. Evitate la ridondanza, le parole "Drupal" e "manuale" dovrebbero essere usate raramente nei titoli. |
1b | Mettete in maiuscolo solo la prima lettera del titolo salvo non si usi un oggetto appropriato. es: Installare moduli; Progettare temi con Dreamweaver. |
1c | Usate "HOWTO: {titolo}" per pagine di documentazione che funzionano come tutorials. |
2. Stile di scrittura | |
2a | Usate grammatica italiana corretta. |
2b | Non usate pronomi in prima persona: Io, mio, noi, nostri, ecc... |
2c | Non usate termini colloquiali. |
2d | Evitate di creare nuova documentazione per argomenti già trattati nei Manuali. |
2e | FATE UN CONTROLLO ORTOGRAFICO. |
3. Formattazione del testo | |
3a | Quando descrivete come arrivare ad una specifica interfaccia utente (es.L'opzione di aggiunta vocabolario nella sezione delle categorie della schermata amministrativa) evidenziate il percorso necessario per accedere all'opzione con questo formato: destinazione (<i>percorso > per > l'oggetto > indicato </i>) Che fornirà un testo simile a questo: destinazione (percorso> per> l'oggetto> indicato) |
3b | Non abbreviate le parole nel percoro di navigazione (es. usate admministra invece di ammin) |
3c | Gli oggetti dei Menù possono cambiare posto ora. Includete sempre il percorso Drupal per ogni opzione di interfaccia utente. |
4. HTML e formattazione del codice | |
4a | Usate liste ordinate per istruzioni passo-passo: <ol> |
4b | Racchiudete gli esempi di codice HTML dentro i tag <code> . |
4c | Racchiudete gli esempi di codice PHP dentro i tag <?php and ?> . |
5. Links | |
5a | Usate il tag "title" se il testo nel link non è abbastanza descrittivo. |
5b | Usate link relativi quando è possibile: Pessimo <a href="http://www.drupal.org/node/1234567" title="informazione"> Buono |
5c | I Link dovrebbero essere inseriti all'interno di normali testi descrittivi: Pessimo Mi piacciono gli stomaci felini. Per avere maggiorni informazioni Buono Il mio organo preferito in un gatto è il suo a |
5d | Quando descrivete un URL di esempio usate sempre 'www.esempio.com' come nome del dominio. |
5e | Includete link a documentazione correlata, rilevante e/o articoli su forum quanto più è possibile. E' sufficiente un link per ogni oggetto di interesse. |