|
⇤ ← Versione 1 del 20/12/2012 14.43.43
Dimensione: 5814
Commento:
|
Dimensione: 5824
Commento:
|
| Le cancellazioni sono segnalate in questo modo. | Le aggiunte sono segnalate in questo modo. |
| Linea 6: | Linea 6: |
| <<BR>> | |
| Linea 10: | Linea 11: |
| = Procedura generale = | == Procedura generale == |
Revisione delle pagine
Gli editori si occupano della pubblicazione delle pagine di documentazione svolte dagli utenti. Per fare questo è necessario eseguire una serie di controlli elencati in questa pagina.
Procedura generale
La procedura standard degli editori può essere riassunta nella sua globalità in questi sei passi:
Tenere d'occhio il forum: controllare di frequente la sezione del forum per la segnalazione di modifiche a pagine esistenti o la creazione di pagine nuove.
Tabella revisioni: inserire i dati di una pagina appena editata nella tabella delle revisioni.
Prendere in consegna: se si è in condizione di farlo, prenotarsi per la revisione della pagina inserendo il proprio nome nella tabella.
Revisionare la pagina: controllare (se possibile) la correttezza della guida e adeguarla agli standard in uso.
Tabella pagine svolte: spostare i dati dalla tabella delle revisioni a quella delle pagine svolte.
Comunicare nel forum: comunicare la fine della revisione e la pubblicazione della pagina nel forum.
Info pagina e macro
Assicurarsi che la pagina contenga:
Macro Indice: posta insieme al rimando a capo in cima alla pagina (sotto eventuali commenti), garantisce la strutura standard a capitoli e paragrafi:
<<BR>> <<Indice()>>
Macro Informazioni: posta sotto la macro Indice, indica versioni supportate e link alla relativa discussone sul forum. È del tipo:
<<Informazioni(forum="INSERIRE_LINK_DISCUSSIONE"; rilasci="12.04, 12.10")>>
Category: posta a fondo pagina indica le categorie di appartennenza. Ad esempio se una pagina fa parte dei portali Hardware e Multimedia sarà del tipo:
---- CategoryHardware CategoryMultimedia
Struttura pagina
La presenza della macro Indice garantisce la struttura in capitoli e paragrafi. Per una migliore leggibilità è bene cercare di mantenere basso il numero di paragrafi o sotto paragrafi.
Cercare (finché possibile) di utilizzare al massimo i capitoli, ossia i titoli di primo livello, del tipo:
= Capitolo =
La strutura di una pagina può variare in base agli argomenti trattati, non esiste uno schema unico. Tuttavia è bene evitare casi "estremi" come ad esempio una pagina costituita da un unico capitolo suddiviso in una decina di paragrafi.
Revisione tecnica
È buona cosa verificare di persona la correttezza dei contenuti. Purtroppo per vari motivi ciò non è sempre possibile (non si disponere dell'hardware trattato, non si conosce nel dettaglio il software trattato, ecc..).
In questi casi cercare comunque di verificare che i passaggi mantengano una logica corretta e che non manchino passaggi fondamentali nella procedura.
Revisione stilistica
È la parte più impegnativa, nella quale occorre controllare che la pagina sia scritta:
in italiano corretto;
in forma impersonale;
in modo sintetico;
e rispetti i formati standard in uso.
In definitiva si tratta di adattare il testo agli esempi riportati nella pagina Standard, che raccoglie gran parte delle casistiche esistenti.
Per approfondire determinati argomenti la Guida Wiki presenta link a guide di vario genere come: inserimento di note e avvisi, struttura delle tabelle, ecc..
|
Spesso il metodo più pratico per risolvere l'editazione di alcuni passaggi, è prendere spunto dalle pagine già esistenti controllandone il codice. |
Indicizzazione pagine
In base all'argomento trattato la pagina sarà linkata nel portale di appartenenza e il nome indicherà il portale o i portali di appartenenza.
Aesempio la pagina sulla gestione del disco:
è stata nominata Hardware/DispositiviPartizioni/GestioneDisco;
ed è linkata nel portale Hardware/DispositiviPartizioni.
|
In caso di afinità una pagina può essere linkata su portali differenti. Ad esempio una guida su di un lettore mp3 può essere indicata sia sul portale multimediale che sul portale hardware. |
Aggiornare le tabelle
A lavoro terminato spostare i dati dalla tabella delle revisioni alla tabella delle pagine svolte.
Comunicare sul forum
Terminata la revisione fare presente sul forum le modifiche apportate comprese le aggiunte delle voci negli indici dei portali.
Più in generale cercare di non essere parsimoniosi nell'uso dei link, in modo da fare sempre presente in modo chiaro a quale pagine si stia facendo riferimento. Questo tenendo anche conto che i post col tempo possono essere disseminati di link a pagine non più esistenti.
