Alessio Treglia

everybody lies
  • Quality Assurance
  • EN blog
  • rss
  • Inizio
  • Chi sono
  • pyRisk
  • Roma3 WiFi Authenticator
  • Installation Report Generator
  • Contattami

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

quadrispro | 13 Ottobre 2007

“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!

Categorie
Documentazione e wiki, Guide e howto
Commenti RSS
Commenti RSS
Trackback
Trackback

« Dieci motivi per usare Linux E Gutsy sia! (Release Candidate) »

8 risposte

Ottima idea, ci voleva :D

Fradeve | 14 Ottobre 2007 | 21:44

Ottima idea, ci voleva :D

[Reply]

Grazie! È il mio primo articolo, sto ancora lavorando molto

quadrispro | 15 Ottobre 2007 | 09:34

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

[Reply]

Ma non è che non l'ho mai letta.............. è che

Supremus | 15 Ottobre 2007 | 12:04

Ma non è che non l’ho mai letta………….. è che non miricordo mai tutti ci mandi cosa vogliono dire………….

[Reply]

[...] Come scrivere una guida e vivere in pace con

Come scrivere una guida e vivere in pace con gli Editori - II parte « Blog di Alessio Treglia | 18 Ottobre 2007 | 15:28

[...] Come scrivere una guida e vivere in pace con gli Editori - I parte [...]

@ Supremus sisi certo :D quadrispo, è bello il tuo blog :)

toto78 | 26 Ottobre 2007 | 01:01

@ Supremus

sisi certo :D
quadrispo, è bello il tuo blog :)

[Reply]

[...] Recenti toto78 on Come scrivere una guida e vive...andreabs

Come scrivere una guida e vivere in pace con gli Editori - II parte « Blog di Alessio Treglia | 26 Ottobre 2007 | 16:03

[...] Recenti toto78 on Come scrivere una guida e vive…andreabs on E Gutsy sia! (Release Candidat…andreabs on Nuova versione, stessa incompa…Come [...]

[...] avete seguito la prima parte del tutorial ora dovreste

Blog di Alessio Treglia » Blog Archive » Come scrivere una guida e vivere in pace con gli Editori - II parte | 31 Ottobre 2007 | 10:28

[...] avete seguito la prima parte del tutorial ora dovreste essere iscritti e pronti per partecipare alla stesura della documentazione. Da che [...]

Beh, che dire.... ... ce n'era proprio bisogno !! LOL

paolettopn | 24 Maggio 2008 | 21:13

Beh, che dire….

… ce n’era proprio bisogno !! LOL ;D

Un saluto,

Paolo

[Reply]

Lascia un commento

Puoi usare questi tag : <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Click to cancel reply

Argomenti

Aggiornamento Ambienti di sviluppo Audio Bug e problemi vari C Cazzate varie Compiz Fusion Comunità Italiana Documentazione e wiki Feisty Firefox GNOME GTK+ GTK Rm3WiFi Authenticator Guide e howto Gutsy Hardy Installation Report Generator Installazione e problemi all'avvio Intrepid Jaunty Java Kernel e moduli Last.fm Musica Notizie Open source & free software Planet Ubuntu-it Programmazione e sviluppo Python Siti,servizi & blog Società e media Traduzioni Ubuntu Università e scienza Viaggi Video Windows Wordpress Xfce Xubuntu

Ultimi commenti

  • quessin@mi su Il mio nuovo laptop: Acer Aspire One A150
  • Roberto su Ubuntu 9.04, chiamiamola per nome
  • Flavio su Roma3, anche Ingegneria esprime il suo dissenso
  • iced su Si riparte!
  • Fabio su Si riparte!

Tutti gli articoli

RSS Planet di Ubuntu-it

  • Aldo Latino (aldolat): Spammoni di fine luglio
  • Paolo Garbin (paolettopn): Intervista al Prof. Ing. Antonio Cantaro
  • Paolo Garbin (paolettopn): Come registrare le vostre chiamate con Skype…
  • Paolo Garbin (paolettopn): Licenza Creative Commons: perchè usarla…
  • Milo Casagrande: @ LA - Day 1

Blogroll

  • (LS) Lorenzo Sfarra
  • Bubuntu
  • crisis
  • Dagospia
  • Divilinux Lost Blog
  • Embrace’s Blog
  • Fradeve OpenBlog
  • Il blog di Totò
  • Il mondo di Paolettopn
  • Leo
  • Maurizio Moriconi
  • Milo Casagrande
  • Parzialmente scremato
  • TuxLinux
  • Ubuntu block notes

RSS alessio and friends on identi.ca

  • milo: back from Universal Studios, getting ready for dinner @ Fogo de Chao
  • milo: tired... but happy owner of a new fotocamera! :)
  • milo: is getting ready for another day in LA
  • milo: is tired... walking all day in LA...
  • milo: enjoyed breakfast with flapjacks+bananas @ TART
  • milo: is hating Los Angeles jet lag...
  • milo: is enjoying Los Angeles...
  • alessio: working
  • alessio: Workin on darcs package
  • alessio: packaging in progress, I think to leave Italian Doc Team seriously

Accedi o registrati

  • Registrati
  • Collegati
  • Voce RSS
  • RSS dei commenti
  • WordPress.org
rss Commenti RSS valid xhtml 1.1 design by jide powered by Wordpress get firefox