Come scrivere una guida e vivere in pace con gli Editori – I parte

“Prima di scrivere una guida è consigliato leggere GuidaWiki e tutte le sue sottopagine, con particolare attenzione a StileDellePagine”, “Non abusare nè del maiuscolo nè del grassetto”, “Rispettare le linee guida”….

Non ricordo bene quante volte, in questi ultimi mesi, sono stato costretto a ripetere commenti del genere in giro per il wiki (Supremus, ti ricorda qualcosa?).

Non posso non ammettere che leggere veramente tutta la guida al Wiki risulta alquanto noioso, è pur vero però che in quella pagina sono indicate tutte le direttive di stile necessarie a mantenere la documentazione comunitaria ordinata, pulita, di comoda lettura e con uno stile il più possibile uniforme.

Per venire incontro ai nuovi utenti (e non solo…) che per le prime volte si affacciano al wiki per condividere con il resto della comunità alcune loro conoscenze ed esperienze, ho deciso di scrivere un mini-Howto sul come impostare una nuova guida.

La prima parte di questo Howto è dedicata quasi esclusivamente a tutti coloro che non hanno mai contribuito alla stesura delle guide sul wiki.

Quali sono i primi passi? Beh, il primo ovviamente è iscriversi al wiki.

Iscriversi al wiki

Durante la procedura di iscrizione è caldamente suggerito di scegliere un username in formato NomeWiki. Un NomeWiki è un termine formato dalla congiunzione di più parole capitalizzate. È il caso di prestare attenzione al fatto che l’unica maiuscola sia in effetti solo l’iniziale, ad esempio:

  • AlessioTreglia
  • MiloCasagrande
  • FilippoGuglielmetti

Una volta scelto il NomeWiki desiderato (la forma NomeCognome non è assolutamente obbligatoria, è semplicemente la preferita dagli utenti) sarà possibile creare la propria Homepage, che avrà come percorso

http://wiki.ubuntu-it.org/NomeWikiScelto

Per creare la propria pagina personale è sufficiente aprire il precedente percorso con un browser e fare clic su «Create new empty page». Non usate l’editor grafico, non funziona bene. Una volta inserite le proprie informazioni personali cliccate pure su «Salva le modifiche». Notate bene che se non cliccate su tale pulsante la pagina non verrà salvata.

Una volta iscritti si passa alla creazione della propria pagina Prove.

Prima di pubblicare una guida all’interno del wiki è sempre meglio creare una bozza della pagina e sottoporla all’attenzione del Gruppo Documentazione.

C’è una pagina particolare all’interno del wiki italiano, la pagina CastelliDiSabbia, dedicata proprio alle bozze del Gruppo Doc. Ma tale pagina è unica e noi utenti siamo numerosi (nonchè innumerevoli e numerati, raramente anche numerici), dunque si è scelto di risolvere tale problema, dando ad ogni singolo utente la possibilità di crearsi una sorta di CastelliDiSabbia personale all’interno della quale preparare tutti i propri lavori. Voi piccoli neofiti ancora vi chiederete: “Dove la creo? Come la chiamo?”. La riposta alla prima domanda è semplice: sotto la propria pagina personale. Per sotto intendo al livello inferiore del percorso della pagina personale, cioè come sottopagina, es:

  • AlessioTreglia/Prove
  • MiloCasagrande/Prove
  • GiuseppeTerrasi/Officina
  • TizioCaio/PaginaDiProva

Dall’esempio penso si possa comprendere facilmente che il nome della pagina per le bozze sia arbitrario: potete chiamarla Prove, Officina, Bozze, InLavorazione… insomma, in questo caso (raro, rarissimo!) la forma passa in secondo piano alla sostanza, basta che il nome della pagina sia un NomeWiki, il resto non conta.

Ora che abbiamo creato la nuova pagina di prove è arrivato il momento di pensare al suo contenuto.

Prima di scrivere la guida vanno osservate le seguenti regole:

  1. verificare la presenza di altre guide che trattano lo stesso argomento; in tal caso si pensi ad un integrazione/ampliamento di tali documenti piuttosto che alla creazione di una nuova pagina;
  2. verificare di avere realmente qualcosa da scrivere (mi batto sempre affinchè le guide contenenti solo un

    sudo apt-get install pacchetto

    vengano impietosamente rimosse);

  3. aprire una nuova discussione nella board del Gruppo Documentazione, proponendo al gruppo le proprie idee.

Il Gruppo Doc non tarderà nel rispondere alle vostre richieste di chiarimenti nè tantomeno ignorerà le idee proposte: nel topic verranno dati suggerimenti, consigli e varie indicazioni su come procedere. Una volta stabiliti dei metodi e delle strategie condivise, si può procedere alla stesura vera e propria della guida.

Quest’utlimo aspetto lo affronto nella prossima puntata.

Ciao!

Facebook Twitter Linkedin Plusone Pinterest Email

8 pensieri su “Come scrivere una guida e vivere in pace con gli Editori – I parte

  1. Grazie! È il mio primo articolo, sto ancora lavorando molto sull’aspetto grafico. Appena ho un po’ di tempo pubblico anche la seconda parte 😉

  2. Pingback: Come scrivere una guida e vivere in pace con gli Editori - II parte « Blog di Alessio Treglia

  3. Pingback: Come scrivere una guida e vivere in pace con gli Editori - II parte « Blog di Alessio Treglia

  4. Pingback: Blog di Alessio Treglia » Blog Archive » Come scrivere una guida e vivere in pace con gli Editori - II parte

Rispondi a paolettopn Annulla risposta

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *

Questo sito usa Akismet per ridurre lo spam. Scopri come i tuoi dati vengono elaborati.