FAQ

Le FAQ (frequently asked questions) contengono le risposte alle domande più frequenti poste da chi si affaccia per la prima volta alla documentazione wiki. Se vuoi sapere come funziona la documentazione della comunità italiana di Ubuntu e vuoi contribuire, qui potrai approfondire vari aspetti.

1. Introduzione

• 1.1 Cos'è il wiki di Ubuntu-it?

• 1.2 Cos'è la documentazione wiki?

• 1.3 Qual è la differenza fra Documentazione Wiki e Manuali di Utilizzo?

• 1.4 Perché dovrei scrivere guide sul wiki piuttosto che su un blog/sito personale?

2. Organizzazione

• 2.1 Come è organizzata la documentazione wiki?

• 2.2 È necessario far parte del Gruppo Doc per modificare il wiki?

• 2.3 Devo già saper creare alla perfezione pagine wiki per scrivere guide?

• 2.4 Posso creare nuove pagine quando mi pare e piace?

3. Come utilizzare gli strumenti

• 3.1 Come si collabora per migliorare la documentazione?

• 3.2 Come si crea un account sul wiki?

• 3.3 Non riesco ad accedere al wiki o a modificare delle guide, come risolvo?

• 3.4 Cos'è una pagina personale?

• 3.5 Come si scrive una guida? Come si scrive in grassetto? Come si inseriscono titoli dei paragrafi e elenchi?

• 3.6 Come si allega un'immagine?

• 3.7 Come si verifica una guida?

• 3.8 Come si corregge una guida esistente?

• 3.9 Cos'è una pagina di prova e come si crea?

• 3.10 Esiste un elenco di guide da aggiornare o correggere?

• 3.11 Come si crea una nuova guida?

• 3.12 Quali argomenti non sono adatti al wiki?

• 3.13 Posso tradurre guide straniere?

• 3.14 Posso collaborare con più persone nella stesura delle guide?

• 3.15 Come si cancella una pagina o un allegato?

4. Gruppo Documentazione

• 4.1 Posso entrare a far parte del Gruppo Doc?

• 4.2 Come si contatta il Gruppo Doc?

1.1 Cos'è il wiki di Ubuntu-it?

Il wiki è una piattaforma aperta di condivisione e collaborazione, che permette ai propri utenti di aggiungere, modificare o cancellare contenuti attraverso un browser web. Il wiki è utilizzato sia dai gruppi di lavoro di Ubuntu-it per coordinare i lavori, sia per la pubblicazione della documentazione wiki riguardante il sistema operativo Ubuntu.
Torna su

1.2 Cos'è la documentazione wiki?

La documentazione wiki è la documentazione scritta da chi utilizza il sistema operativo Ubuntu. Qualsiasi utente può partecipare alla stesura delle guide.
Sai cosa occorre per configurare un programma? Sai come installare determinati driver di una periferica hardware o altro ancora? Se vuoi condividere sul wiki le soluzioni che hai trovato, sei il benvenuto!
Torna su

1.3 Qual è la differenza fra Documentazione Wiki e Manuali di Utilizzo?

Mentre la Documentazione Wiki è modificabile appunto attraverso il wiki da qualsiasi utente, i Manuali di Utilizzo seguono un iter di sviluppo completamente differente, essendo essi la traduzione della documentazione allegata al sistema operativo. Per poter partecipare alla traduzione dei manuali, occorre rivolgersi al Gruppo Traduzione.
Torna su

1.4 Perché dovrei scrivere guide sul wiki piuttosto che su un blog/sito personale?

• Partecipando a un progetto di scrittura collaborativa, anche se un giorno non potrai più occuparti di un argomento, altre persone potranno subentrare per aggiornare i contenuti.

• Partecipando con più persone è possibile avere più punti di vista, attraverso i quali diventa più semplice far emergere errori/inesattezze e quindi intervenire per migliorare le pagine.

• Radunare le guide sul sito ufficiale di un sistema operativo, rende meno dispersiva la ricerca delle soluzioni ai problemi.
  

Torna su

2.1 Come è organizzata la documentazione wiki?

La documentazione wiki è suddivisa in Aree tematiche, per aiutare chiunque voglia consultarla a trovare velocemente gli argomenti di interesse.

• Compito degli utenti è di aggiornare e rinnovare la documentazione: ogni aiuto è il benvenuto!!

• Compito del Gruppo Doc è di mantenere ordinate e facilmente consultabili le guide scritte dalla comunità, revisionare e adattare agli standard le guide create o aggiornate dagli utenti. Inoltre i membri del Gruppo Doc sono contattabili per consigli, chiarimenti, aiuti nella editazione delle pagine e altre domande.
  

Torna su

2.2 È necessario far parte del Gruppo Doc per modificare il wiki?

Assolutamente no. Chiunque può correggere le guide wiki o crearne di nuove, anche tu!
Il Gruppo Doc si occupa di mantenere ordinata la documentazione wiki, sia curando l'impostazione dei documenti scritti dagli utenti, sia avendo cura che la pagina sia pubblicata nella sezione appropriata del sito.

Torna su

2.3 Devo già saper creare alla perfezione pagine wiki per scrivere guide?

Assolutamente no. Non occorre essere scrittori, riportare i passaggi in modo schematico è più che sufficiente. Chi utilizza il wiki per la prima volta in questa pagina può vedere come trasformare le parole in titoli di paragrafi, in testo in grassetto, in link, ecc..
In realtà le guide seguono alcune impostazioni e se ti va di seguirle non può che farci piacere. Ma se ritieni che siano complicate, scrivi nel modo in cui ti riesce meglio, al resto pensa il Gruppo Doc durante la revisione.
Torna su

2.4 Posso creare nuove pagine quando mi pare e piace?

È molto importante non creare pagine doppione, che i contenuti non si replichino su pagine differenti e che gli argomenti siano attinenti alla documentazione wiki. Pertanto, mentre le modifiche banali (correzioni di nomi/parole sbagliate, link rotti, ecc..) possono essere immediatamente eseguite, per la creazione di nuove guide o la profonda revisione di quelle già esistenti occorre avvisare il Gruppo Doc nella apposita sezione del forum.
In questo modo è possibile monitorare i lavori, accertarsi che i nuovi argomenti non siano in realtà già presenti o che non esulino dagli obiettivi del wiki.
Torna su

3.1 Come si collabora per migliorare la documentazione?

Sei libero di verificare le guide esistenti, di correggerle e aggiornarle, di scriverne di nuove:

• Verifica di una guida: se hai consultato un procedimento che funziona, ma la versione di Ubuntu (o derivata) su cui hai effettuato le modifiche non è indicata alla voce Guida verificata con Ubuntu: 14.04, 12.04 ... posta sotto l'Indice della guida wiki, puoi inserire tu stesso la verifica alla guida.

• Errori banali: se trovi nomi sbagliati, errori ortografici, collegamenti errati, ecc.. correggili pure!

• Grosse modifiche/Nuove pagine: se vuoi apportare delle modifiche importanti ad una guida wiki o vuoi crearne una nuova, metti al corrente il Gruppo Doc nel forum e saremo felici di consigliarti e aiutarti.
  

Torna su

3.2 Come si crea un account sul wiki?

È necessario avere un account per modificare le pagine del wiki. Per crearlo, consulta la pagina Iscriversi al wiki.

Torna su

3.3 Non riesco ad accedere al wiki o a modificare delle guide, come risolvo?

Consulta la pagina Risoluzione problemi.
Se hai altri problemi e non riesci a risolvere, puoi contattare il Gruppo Doc.
Torna su

3.4 Cos'è una pagina personale?

È una pagina in cui parli di te e ti presenti al resto della comunità, sei libero di scrivere quello che vuoi
La pagina personale è utile per fare pratica con il wiki, per elencare le guide che ti interessano, per indicare i tuoi contributi o come vuoi iniziare a contribuire...

Spesso la pagina personale viene utilizzata anche come Indice personale, per raggruppare le tue pagine di prova. Ad esempio è possibile creare la pagina di prova MarioRossi/Prova1, che è una sotto-pagina della pagina personale MarioRossi.

Consulta questa pagina wiki per sapere come creare la tua pagina personale.
Torna su

3.5 Come si scrive una guida? Come si scrive in grassetto? Come si inseriscono titoli dei paragrafi e elenchi?

Non esiste un unico metodo per scrivere una guida wiki. Puoi avvalerti di un modello o copiare una guida esistente da incollare e modificare in una nuova pagina.

Per imparare a formattare correttamente una pagina wiki, dai un'occhiata alla Guida in 10 passi più uno ;)
Torna su

3.6 Come si allega un'immagine?

Non è generalmente necessario caricare immagini in una guida, sia per evitare di appesantire troppo il wiki, sia perché nella maggior parte dei casi le procedure indicate dalle guide non richiedono immagini esplicative. Pertanto, se non è strettamente necessario, si evita di caricare immagini sul wiki che col tempo andrebbero aggiornate o rimosse.

Se comunque desideri inserire un'immagine che ritieni utile in una guida wiki, visualizza la guida in questione e seleziona la voce Allegati nella barra grigia superiore del wiki.
Una volta caricata l'immagine, puoi usare:

<<Immagine(./nomeimmagine.png,)>>

oppure:

{{nomeimmagine.png}}

per visualizzare l'immagine nella guida.

Ricordati di utilizzare solo immagini non coperte da copyright e in formato .png.
Torna su

3.7 Come si verifica una guida?

La verifica di una guida è una funzionalità molto utile, in quanto permette a tutti gli utenti di valutare la validità dei contenuti di una pagina. Se ad esempio una guida è verificata con la versione di Ubuntu installata nel tuo PC, ciò implica che qualche utente ha già eseguito con successo le procedure indicate, in una versione di Ubuntu identica alla tua. Pertanto il rischio di incappare in problemi è relativamente basso.

Se desideri verificare una guida con un rilascio supportato di Ubuntu, accedi al wiki e modifica la pagina interessata inserendo alla voce:

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

la tua versione di Ubuntu. Ad esempio, se vuoi aggiungere la verifica per Ubuntu 16.04, il risultato sarà simile al seguente:

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

Nota inoltre che non tutte le pagine wiki necessitano di verifica da parte degli utenti. Le pagine Indice (ad esempio AmministrazioneSistema) oppure le guide più generiche (ad esempio AmministrazioneSistema/ComandiBase) non devono essere verificate con alcun rilascio di Ubuntu perché sempre valide.
Torna su

3.8 Come si corregge una guida esistente?

Se desideri aggiornare o correggere una guida già presente nel wiki, puoi farlo tramite una Pagina di prova. Procedi in questo modo:

1. accedi al wiki e visualizza la pagina che vuoi aggiornare;

2. nella barra grigia superiore del wiki seleziona la voce Altre azioni → Mostra il testo grezzo, quindi copia tutto il suo contenuto;

3. crea una Pagina di prova e incolla al suo interno il testo precedentemente copiato, quindi salva.

Ora sei libero di apportare nella Pagina di prova tutte le modifiche che vuoi. Appena terminata, informa il Gruppo Doc sul forum in modo che la pagina venga revisionata e nel caso riadattata dallo staff.
Torna su

3.9 Cos'è una pagina di prova e come si crea?

Una pagina di prova è in pagina non indicizzata (non è raggiungibile dall'Indice della documentazione wiki) che puoi liberamente creare e modificare a tuo piacimento.
Per maggiori informazioni puoi consultare questa pagina.
Torna su

3.10 Esiste un elenco di guide da aggiornare o correggere?

Le guide da aggiornare e correggere o che richiedono la verifica con un rilascio supportato, vengono elencate nella pagina CategoryDaRevisionare.
Sei libero di scegliere una di queste pagine e dedicarti alla sua correzione.
Torna su

3.11 Come si crea una nuova guida?

Le nuove guide possono essere create da subito col nome dell'argomento trattato.
Una volta fatto, puoi utilizzare il Nuovo documento per scrivere la tua guida. Appena terminata, informa il Gruppo Doc sul forum in modo che la pagina venga revisionata e nel caso riadattata dallo staff.
Torna su

3.12 Quali argomenti non sono adatti al wiki?

Di norma viene accettato tutto quello che può servire a risolvere problemi di configurazione software/hardware e in generale scavalcare le difficoltà che possono verificarsi nell'utilizzo di Ubuntu. Potrebbero invece essere scartati:

• Argomenti troppo generici: argomenti generalisti di stampo enciclopedico (ad es. approfondimenti su linguaggi di programmazione, su protocolli di rete, ecc..). In questi casi potrebbe essere più indicato rivolgersi a uno strumento come Wikipedia. Si tratta di valutare di volta in volta.

• Argomenti troppo banali: ad esempio limitarsi a segnalare l'installazione di un pacchetto software già disponibile in Ubuntu, senza ulteriori indicazioni.
  

Torna su

3.13 Posso tradurre guide straniere?

Occorre precisare che quello che interessa nelle pagine della documentazione sono i contenuti, ossia i passaggi utili a risolvere una problematica. Pertanto non interessa una traduzione "impeccabile" nella forma come avviene ad esempio per la traduzione dei software o della documentazione allegata ai software. La cosa importante è schematizzare i passaggi delle procedure da utilizzare, lo stile verrà comunque riadattato a quello in uso sul wiki in fase di revisione.
Torna su

3.14 Posso collaborare con più persone nella stesura delle guide?

Certamente! Poiché tutti possono editare il wiki, è anche possibile che più persone collaborino alla creazione o alla modifica di una guida. L'unico limite consiste nel non poter scrivere la stessa pagina contemporaneamente.
Torna su

3.15 Come si cancella una pagina o un allegato?

È possibile fare delle richieste specifiche al Gruppo Doc, come l'eliminazione di pagine di prova personali, immagini o altro, tramite la pagina ToDoWiki.
In alternativa puoi contattare direttamente i membri dello staff.
Torna su

4.1 Posso entrare a far parte del Gruppo Doc?

È possibile entrare a far parte del Gruppo Documentazione solo dopo che ci si è cimentati con la stesura di qualche pagina. È importante dimostrare di avere un minimo di dimestichezza con gli strumenti del wiki, una certa cura nella scrittura delle pagine e una certa presenza nella sezione del forum. Si può avere una panoramica delle attività leggendo il vademecum degli editori.
Più in generale nella pagina Organizzazione sono riportate notizie utili per entrare a far parte del gruppo.
Torna su

4.2 Come si contatta il Gruppo Doc?

Il Gruppo Documentazione è contattabile su: forum, Mailing List e canale IRC #ubuntu-it-doc.
Per la creazione o modifica delle guide wiki, il "luogo" in cui preferiamo consultarci è il forum, dove per ogni guida esiste una discussione specifica.
Torna su

CategoryComunitaDocumentazione