La presente guida vuole essere un aiuto a coloro che desiderano cimentarsi con la traduzione o l'aggiornamento di documentazione. Sebbene sia applicabile in generale alla traduzione da qualsiasi lingua all'italiano, essa è pensata per la traduzione da documenti scritti in inglese, soprattutto perché quasi tutta la documentazione reperibile sul software libero è scritta originariamente in inglese.

1 Punti di riferimento

La prima cosa da tener presente da parte di ogni traduttore è che la traduzione non è un'attività artistica la cui esecuzione è lasciata al libero arbitrio delle persone, ma segue delle regole, dettate non da qualche "guru" o programmatore, ma dalla stessa lingua italiana. Una parte di queste regole è riportata nel documento "Regole per la buona traduzione", pubblicata e mantenuta dal Translation Project (TP), che dovrebbe essere letta attentamente e tenuta come punto di riferimento da tutti i traduttori. Per i casi più controversi, non riportati dalla guida sopra citata, si consiglia di chiedere sempre chiarimenti alla mailing list di ILDP o del TP, e, ove nemmeno esse riescano a dare una risposta, è possibile fare riferimento al sito dell'Accademia della Crusca, ovvero l'istituto nazionale per lo studio e la salvaguardia della lingua italiana, nella sezione la lingua in rete.
In generale i punti fondamentali e più evidenti consistono nel non dare del tu al lettore (questo documento è un esempio) e nel non mettere al plurale le parole inglesi intraducibili ("il byte" - "i byte" e non "i bytes").
Un'altro documento molto importante, pubblicato sempre dal TP, è il glossario, il quale riporta la traduzione corretta di alcuni termini informatici inglesi, ove questa traduzione esista, oppure ci informa che il termine rimane inalterato in italiano. Ad esempio la parola "byte" rimane tale anche nei testi italiani, e non ha alcuna traduzione (anche se qualcuno ha tentato di imporre, senza successo, il termine "ottetto", mutuandolo dal francese).

2 Strumenti

Chi traduce non ha bisogno di molti strumenti, e quelli necessari sono comunque molto semplici.
Lo strumento principe di ogni traduttore è, ovviamente, il dizionario, sia esso cartaceo oppure on line. Un dizionario cartaceo di buona qualità è sicuramente un'ottimo strumento, ma molte persone preferiscono utilizzare i dizionari accessibili on line, di uso più immediato. A questo proposito è possibile trovarne di ottima qualità e gratuiti, alcuni gestiti direttamente dalle società che pubblicano i dizionari cartacei. Si tenga presente, comunque, che le definizioni e gli esempi forniti dai dizionari on line sono meno completi rispetto alla controparte cartacea.
Un secondo strumento, essenziale per il lavoro del traduttore, è un editor di testo con riconoscimento della sintassi, per distinguere a colpo d'occhio i tag dal testo da tradurre. Nel sistema operativo GNU/Linux praticamente ogni editor di testo implementa anche il riconoscimento della sintassi. Si può utilizzare ad esempio il classico VIM (per i "puristi", che amano la linea di comando) o la sua controparte grafica GVIM. Per gli utilizzatori di KDE l'editor più potente è sicuramente Kate, il quale può anche essere potenziato grazie a un sistema di plugin che permette di aggiungere nuove funzionalità, mentre chi preferisce Gnome potrà trovare ottimo Gedit. Chi invece è costretto ad utilizzare Windows (magari perché è installato sul laptop aziendale) potrà trovare ottimo l'editor freeware ConTEXT, uno dei pochi che in questo sistema operativo implementa anche il riconoscimento della sintassi.

3 Decidere cosa tradurre

Spesso la molla che spinge a contribuire alla traduzione di documentazione sul software libero è il desiderio di mettere a disposizione di tutti un documento che è stato particolarmente utile per risolvere un proprio problema. In questo caso il dubbio su cosa tradurre non esiste, ma in altri casi si è semplicemente spinti dal desiderio di far parte della comunità del software libero e di dare il proprio contributo. Se non si ha alcuna esperienza di traduzione di documentazione si consiglia di cimentarsi prima con un paio di revisioni, in modo da prendere familiarità con la terminologia e con il modo di scrivere appropriato per le traduzioni.
Nel momento in cui ci si sente pronti per affrontare una traduzione la prima cosa da fare è verificare quali documenti si possono tradurre. Lo scopo in questa fase è di eliminare il rischio di tradurre qualcosa che è già stato tradotto, o di iniziare una traduzione che sta già facendo qualcun altro.
Di seguito si cercherà di guidare il lettore nella scelta del documento da tradurre, in funzione anche dell'impegno richieso per tradurlo.

3.1 HOWTO

Per chi vuole tradurre un HOWTO esiste la pagina dello stato traduzioni. Essa riporta l'elenco completo in forma tabellare degli HOWTO disponibili su TLDP, e, con un'apposita grafica, informa su quali HOWTO sono tradotti, quali in traduzione e quali sono da aggiornare perché la traduzione è precedente all'ultima versione.
Scorrendo la lista di questa pagina si può cercare tra gli HOWTO da tradurre quello più adatto, perché, ad esempio si è ferrati su quell'argomento o perché piace più di altri.
Dalla pagina dello stato traduzioni si può accedere direttamente al documento. Facendo clic sul titolo si accede alla pagina del sorgente del documento nel server CVS, facendo clic sulla data dell'ultima versione inglese si accederà alla versione html del documento, mentre facendo clic sulla data dell'ultima versione in italiano (se c'è) si accede alla pagina dell'HOWTO nel sito di ILDP.
Un HOWTO può risultare non tradotto, e quindi richiedere una traduzione da zero, oppure può necessitare di un aggiornamento, perché dopo la sua traduzione l'originale in inglese è stato aggiornato ad una nuova versione. Il procedimento da seguire differisce nei due casi, e quindi essi verranno trattati separatamente.

3.1.1 Traduzione degli HOWTO

Per tradurre un howto è necessario scaricare il sorgente sgml/xml dell'HOWTO stesso dal server CVS di TLDP. Per far questo si può andare sul sito di TLDP, oppure accedere alla pagina CVS dell'howto cliccando sul titolo del documento nella pagina dello stato traduzioni. Da qui si può scaricare l'ultima versione dell'HOWTO sul proprio disco locale. Per tradurre non è necessaria alcuna conoscenza dei linguaggi sgml e xml o dei formati linuxdoc e docbook, quindi non ci si deve preoccupare se non si capisce il contenuto dei tag. L'importante è tradurre il testo in inglese che si trova tra i tag, evitando di tradurre il contenuto dei tag stessi.
È molto importante che l'HOWTO venga tradotto con accuratezza e in un buon italiano, quindi nella traduzione non si deve avere fretta, e, se si trovano frasi di difficile interpretazione, non si deve avere timore di chiedere aiuto nella lista di ILDP. Un buon metodo per valutare la qualità della traduzione è di "dimenticare" l'HOWTO tradotto per un periodo di tempo, almeno una settimana, e rileggerlo a mente fredda. Così facendo spesso si notano immediatamente i punti in cui l'italiano risulta poco scorrevole, farraginoso, o addirittura grammaticalmente scorretto. Ricordarsi sempre che la qualità della traduzione viene prima di ogni altra considerazione, quindi è meglio non tradurre, piuttosto che pubblicare una traduzione fatta con fretta e approssimazione.

3.1.2 Come farsi assegnare un HOWTO

La procedura per diventare i traduttori ufficiali di un certo HOWTO è molto semplice. Dopo aver controllato nella pagina dello stato traduzioni che l'HOWTO non sia già stato tradotto o non sia in traduzione bisogna fare richiesta al coordinatore del progetto. Se il coordinatore del progetto dà il suo assenso si può procedere con la traduzione. Nello stesso tempo il coordinatore modificherà la pagina dello stato traduzioni perché risulti che l'HOWTO è in corso di traduzione, e non venga così richiesto da altre persone.

3.2 Guide

Le guide sono in tutto e per tutto simili agli HOWTO, con la differenza che trattano gli argomenti in modo molto più approfondito. I sorgenti SGML delle guide non sono disponibili sul sito di TLDP, pertanto essi dovranno essere cercati sul sito dell'autore del documento.
La sezione guide non ha una pagina di stato traduzione come gli HOWTO, principalmente perché le guide sono poche (una quindicina contro oltre 400 HOWTO), e, quindi, facilmente gestibili. Se si intende tradurre una guida, quindi, si consiglia di accedere alla sezione GUIDE di ILDP e verificare quali sono state tradotte. Quindi seguire la procedura di richiesta al coordinatore come per gli HOWTO.

3.3 Man page

Le man page in italiano sono divise in due pacchetti, le cui finalità sono descritte nella pagina collaborare. Se si vuole tradurre una pagina di manuale dal pacchetto ufficiale è possibile controllare se questa pagina è già stata tradotta scaricando il pacchetto in italiano e verificando se la pagina è presente. Nel caso in cui non sia ancora stata tradotta bisogna informare il coordinatore del progetto della propria intenzione di tradurla, per evitare di sovrapporsi se qualcun altro la sta già traducendo. Nel caso in cui la pagina sia libera è possibile iniziare la sua traduzione.

3.3.1 Traduzione delle man page

Per tradurre una man page bisogna scaricare l'ultima versione del pacchetto inglese e prelevare la man page da tradurre. Il formato delle man page è groff. Groff è un linguaggio per la formattazione dei testi che non utilizza tag. I comandi di groff sono dei codici di una o più lettere maiuscole precedute da un punto. Questi codici dicono come bisogna formattare il testo che segue. Ovviamente questi codici speciali non vanno tradotti, né modificati.
È importante, inoltre, rispettare gli a capo del documento originale, perché i comandi groff si applicano a tutta la riga di testo che segue, quindi quando ad esempio si vuole mettere in grassetto una sola parola questa deve essere l'unica parola sulla riga.

3.3.2 Aggiornamento delle man page

Per l'aggiornamento delle man page è necessario distinguere tra il pacchetto ufficiale e il pacchetto extra.

3.3.2.1 Pacchetto ufficiale

Per quanto riguarda le man page del pacchetto ufficiale l'aggiornamento delle pagine già tradotte viene fatto esclusivamente dal manutentore. Questo si rende necessario perché il pacchetto ufficiale inglese è spesso soggetto ad aggiornamenti, e va tenuto costantemente monitorato, per tenere al passo anche quello italiano. In caso contrario si rischierebbe di ritrovarsi ben presto con un pacchetto obsoleto e inutilizzabile. Dal momento che l'aggiornamento del pacchetto ufficiale è a carico del manutentore la traduzione di queste man page è un lavoro una tantum, attività ideale per chi ha una disponibilitè di tempo limitata, e sa che non potrè occuparsi anche della manutenzione del documento tradotto.

3.3.2.1 Pacchetto extra

Il senso del pacchetto extra è quello di offrire la traduzione delle man page dei pacchetti software che non si trovano nel pacchetto ufficiale. Chi traduce le man page ad esempio del software XYZ dovrà occuparsi anche della loro manutenzione. Per farlo è necessario tenere monitorato il pacchetto XYZ e verificare ad ogni suo cambio di versione se ci sono modifiche anche nelle man page. Per rendere più efficiente e meno noioso questo compito ci sono alcuni trucchi efficaci:

  • mantenere sul proprio disco una copia originale in inglese delle man page che sono state tradotte
  • verificare la data di salvataggio delle man page contenute nell'ultima versione del pacchetto. Se tale data è successiva a quella delle proprie man page esse vanno aggiornate.
  • se non ci si fida della data di salvataggio è possibile usare un software di confronto come vimdiff, che evidenzia le differenze tra due documenti. Questo, oltre a informare se il documento è cambiato, semplifica enormemente il suo aggiornamento, poiché dice anche dove è cambiato.
  • per monitorare senza fatica il pacchetto e sapere immediatamente se è stato aggiornato è possibile andare sul sito freshmeat.net e sottoscrivere il pacchetto. Ogni volta che freshmeat riceve dagli autori una nuova versione del programma, esso informa immediatamente via email gli utenti che lo hanno sottoscritto.

4 Sottoporre la traduzione

Al termine del lavoro la traduzione deve essere inviata al coordinatore di ILDP. Il lavoro, tuttavia, non è ancora terminato, poiché il coordinatore di ILDP affiderà la traduzione a un revisore, il quale la leggerà e sottoporrà le proprie correzioni al traduttore stesso (si veda a questo proposito la Guida per il revisore).