Wiki Ubuntu-it

Indice
Partecipa
FAQ
Wiki Blog
------------------
Ubuntu-it.org
Forum
Chiedi
Chat
Cerca
Planet
  • Pagina non alterabile
  • Informazioni
  • Allegati
  • Differenze per "GruppoDocumentazione/VademecumEditori"
Differenze tra le versioni 5 e 6
Versione 5 del 22/09/2014 12.53.20
Dimensione: 5866
Autore: jeremie2
Commento: Acl
Versione 6 del 03/10/2014 17.59.29
Dimensione: 6431
Autore: jeremie2
Commento: Nome e indicizzazione pagine
Le cancellazioni sono segnalate in questo modo. Le aggiunte sono segnalate in questo modo.
Linea 70: Linea 70:
= Indicizzazione pagine = = Nome e indicizzazione pagine =
Linea 72: Linea 72:
In base all'argomento trattato la pagina sarà linkata nel portale di appartenenza e il nome indicherà il portale o i portali di appartenenza.<<BR>>
Ad esempio la pagina sulla [[Hardware/DispositiviPartizioni/GestioneDisco|gestione del disco]]:
In base all'argomento trattato la pagina sarà linkata nel portale di appartenenza e il nome, oltre all'argomento trattato dovrà indicare il portale e gli eventuali sotto-portali di appartenenza. Ad esempio la pagina sulla [[Hardware/DispositiviPartizioni/GestioneDisco|gestione del disco]]:
Linea 76: Linea 75:

Se una pagina in revisione non ha già un nome appropriato, è opportuno rinominarla attraverso il menù a tendina '''Altre azioni:''' (presente in alto in ogni pagina) selezionando la voce '''Rinomina pagina'''.<<BR>>
Se la pagina in questione è una '''pagina di prova''' per una guida già esistente, allora a revisione ultimata sarà sufficiente eseguire il copia/incolla dei contenuti sulla pagina ufficiale, inserendo un commento in modo che sia chiaro quale utente abbia contribuito alle modifiche.



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:

  1. Tenere d'occhio il forum: controllare di frequente la sezione per la segnalazione di modifiche a pagine esistenti o la creazione di pagine nuove.

  2. Tabella revisioni: inserire i dati di una pagina appena editata nella tabella delle revisioni.

  3. Prendere in consegna: se si è in condizione di farlo, prenotarsi per la revisione della pagina inserendo il proprio nome nella tabella.

  4. Revisionare la pagina: controllare (se possibile) la correttezza della guida e adeguarla agli standard in uso.

  5. Tabella pagine svolte: spostare i dati dalla tabella delle revisioni a quella delle pagine svolte.

  6. 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, 14.04")>>
  • Category: posta a fondo pagina indica le categorie di appartenenza. 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 struttura 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 dispone 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

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.

Nome e indicizzazione pagine

In base all'argomento trattato la pagina sarà linkata nel portale di appartenenza e il nome, oltre all'argomento trattato dovrà indicare il portale e gli eventuali sotto-portali di appartenenza. Ad esempio la pagina sulla gestione del disco:

  • è stata nominata Hardware/DispositiviPartizioni/GestioneDisco;

  • ed è linkata nel portale Hardware/DispositiviPartizioni.

Se una pagina in revisione non ha già un nome appropriato, è opportuno rinominarla attraverso il menù a tendina Altre azioni: (presente in alto in ogni pagina) selezionando la voce Rinomina pagina.
Se la pagina in questione è una pagina di prova per una guida già esistente, allora a revisione ultimata sarà sufficiente eseguire il copia/incolla dei contenuti sulla pagina ufficiale, inserendo un commento in modo che sia chiaro quale utente abbia contribuito alle modifiche.

In caso di affinità 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.

Ulteriori risorse


CategoryComunitaDocumentazione