Introduzione

Questa pagina raccoglie le principali attività svolte dagli editori su wiki e forum.

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 e aggiornare.

5. Comunicare nel forum: comunicare la fine della revisione e la pubblicazione della pagina nel forum e aggiornare la tabella di riepilogo.

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 struttura standard a capitoli e paragrafi:

  <<BR>>
  <<Indice()>>

• Macro Informazioni: posta sotto la macro Indice, indica versioni supportate e link alla relativa discussione sul forum. È del tipo:

  <<Informazioni(forum="INSERIRE_LINK_DISCUSSIONE"; rilasci="12.04 14.04")>>

  In modo analogo il primo messaggio di una discussione sul forum dovrà riportare il link alla rispettiva guida.

• 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..

Licenze dei contenuti

La licenza utilizzata dal wiki è la Creative Commons BY-SA 3.0. Immagini e testi pubblicati su altri siti con la medesima licenza possono essere a sua volta pubblicati sul nostro wiki, riportando nel capitolo Ulteriori risorse il link al documento originale.

In linea di principio per evitare qualsiasi problema è buona cosa che gli utenti riportino con parole proprie le procedure riportate sulle guide, evitando i copia/incolla da altre guide e procurando in prima persona eventuali immagini.

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 Partizioni:

• è stata nominata Hardware/DispositiviPartizioni/Partizioni;

• 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.

Aggiornare le tabelle

A lavoro terminato spostare i dati dalla tabella delle revisioni alla tabella delle pagine svolte.

Comunicare sul forum

1. Fare presente sul forum le modifiche apportate comprese le aggiunte delle voci negli indici dei portali. 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;

2. Assicurarsi inoltre che nel primo messaggio della discussione sia inserito il link alla rispettiva guida (o guide se più di una).

Per modificare il primo post:

1. Fare clic sul tasto Modifica.

2. In fondo al messaggio inserire il link con un testo del tipo:

   :::::::::::::::::::::::::::::
   Link alla guida [wiki]Hardware/DispositiviSenzaFili/Ndiswrapper[/wiki]

3. Alla voce Motivo della modifica del messaggio inserire un breve messaggio, tipo:

   Inserimento link alla pagina wiki

   In questo modo verrà stampata la data dell'ultima modifica, il nome di chi l'ha eseguita e il motivo.

4. Fare clic su Invia per applicare la modifica.

Pagine rinominate e redirect

Quando una pagina già esistente deve essere rinominata è opportuno creare una nuova pagina con il vecchio nome e impostare su di essa un redirect. In questo modo si evita di "rompere" i link che puntano a quella stessa pagina col vecchio nome (link presenti nel wiki, indicizzati dai motori di ricerca o semplicemente salvati nei segnalibri dai singoli utenti).

Esempio dove una pagina è stata rinominata PaginaConNuovoNome.

1. Ricreare una pagina con il vecchio nome: PaginaConVecchioNome.

2. Inserire il redirect nella PaginaConVecchioNome:

   #redirect PaginaConNuovoNome

3. Salvare la pagina.

Pagine obsolete

Pagine da verificare

Quando un rilascio va fuori supporto (EOL), le pagine che erano verificate fino a tale rilascio divengono obsolete e necessitano di essere verificate con un rilascio ancora supportato.
In questi casi, se non si riesce a testare e verificare la pagina personalmente, inserire a fine pagina il testo:

CategoryDaRevisionare

in modo tale che la guida venga inserita nell'elenco delle guide che necessitano di verifica e aggiornamento.

Cestino

Quando una pagina contiene informazioni o procedure datate e non più attuabili, è necessario rinominare la pagina e inserirla nel Cestino:

1. Controllare e se necessario rimuovere o commentare i collegamenti dalle altre pagine wiki alla pagina interessata.

2. Rinominare la pagina in Cestino/NomeDellaPagina; ad esempio Hardware/Notebook/DellInspirion6400 va rinominata in Cestino/DellInspiron6400.

3. Inserire ad inizio pagina la MacroCestino:

   <<Include(StrumentiWiki/MacroCestino)>>

4. Cancellare tutte le Categorie a fine pagina e inserire:

   CategoryDaCancellare

Cancellazione pagine

Talvolta può essere necessario cancellare pagine in disuso tramite il menù a tendina Altre azioni: selezionando la voce Elimina pagina.
A causa di un malfunzionamento è possibile che alcune pagine particolarmente datate non siano cancellabili. Tali pagine mostrano l'avviso:

La copia di backup di questa pagina è deprecata e il suo punteggio nelle ricerca sarà basso.

Si può ovviare a questo problema ripristinando una versione precedente della pagina e quindi cancellarla in un secondo momento.

1. Selezionare il link Informazioni in alto a sinistra per visualizzare l'elenco delle revisioni.

2. Fare clic sul link Mostra di una delle revisioni precedenti (preferibilmente la prima).

3. Dal menù a tendina Altre azioni: selezionare Elimina pagina.

Ulteriori attività

Infine, un elenco di attività da svolgere occasionalmente:

• Versioni in EOL

  • Commentare o eliminare dalla documentazione i riferimenti a versioni di Ubuntu non più supportate. Si ricorda di non cancellare le pagine relative a note di rilascio e file torrent, in quanto contengono collegamenti incrociati con forum, sito web e newsletter.

• Redirect

  • Controllare la situazione dei redirect all'interno del wiki e valutare quali siano veramente necessari e quali superflui.

  • Correggere i redirect multipli; in alcuni casi è possibile trovare pagine che reindirizzano più volte, ad esempio:
    Synaptic → AmministrazioneSistema/Synaptic → AmministrazioneSistema/InstallareProgrammi/GestorePacchetti.
    In questi casi, va corretto il redirect nella pagina Synaptic in modo che rimandi direttamente all'ultima pagina.

• Collegamenti

  • Sfogliare la documentazione e controllare i collegamenti in cerca di pagine spostate o sparite. Una volta trovata la pagina morta, correggere il collegamento alla pagina nuova.

• Immagini

  • Solo all'interno della documentazione wiki, sostituire le immagini .jpg con immagini in formato .png. Ignorare le immagini presenti nelle pagine personali degli utenti o quelle riguardanti altri gruppi di lavoro.
    Una volta sostituite, correggere il collegamento alle immagini nelle pagine wiki.

• Categorie

  • Controllare che le Categorie al termine delle pagine wiki siano corrette.

Ulteriori risorse

• Pagina del Gruppo Doc

• Guida Wiki

CategoryComunitaDocumentazione