Linee guida su come scrivere una ... guida :D

Può sembrare strano scrivere una guida su come scrivere guide, ma penso sia una necessità, se vogliamo che le guide proposte abbiano le migliori chances di essere pubblicate e che io non sia oberato di lavoro.

Allora, stai pensando di scrivere una guida per poi pubblicarla su Doom9. Ecco cosa devi tenere a mente:

• Non scoprire l'acqua calda. C'è abbondanza di guide su questo sito, e non ha senso spiegare la stessa cosa più volte, cambiando soltanto le parole. Piuttosto, prova a basare il tuo lavoro sui documenti esistenti, e quindi scrivi solo la parte che è realmente originale. Se l'integrazione di nuove parti in una guida già esistente può essere fonte di problemi (perché il documento esistennte non ha sufficienti informazioni o ne ha troppe), mettiti in contatto con noi - è sempre possibile modificare i documenti esistenti.
  Se hai in mente un ampliamento di una guida, non devi scriverne una intera, ma piuttosto, per prima cosa contattaci: probabilmente possiamo integrare la tua idea all'interno delle guide esistenti, senza scrivere alcun nuovo documento.
• Usa un vero editor HTML. L'esportazione di codice HTML di Word è mediocre (per non dire di peggio). Strumenti potenti, tuttavia facili da usare come editor HTML (non richiedono l'apprendimento dell'HTML) sono Dreamweaver o Frontpage (preferibilmente nella versione 2003, dato che le precedenti sono peggiori).
• Scegli il formato più appropriato per gli screenshot : le GIF sono adatte per la maggiorparte degli screenshot, finchè non hai la necessità di mostrare un'immagine live (qualcosa tratto da un film), nel qual caso il formato jpeg è il più appropriato. Fai attenzione a che non ci siano difetti visibili nelle immagini (a maggior ragione se fai una jpeg che mostra non solo una immagine live ma anche elementi generati dal computer (finestre del programma)).
  
  I programmi più recenti qualche volta usano una grafica che richiama Windows XP. Usare uno screenshot in formato GIF di tali programmi comporterà degli evidenti difetti visivi
  
  
  
  In questi casi va usato il formato PNG (e non dimenticare di ripristinare il formato GIF per gli shot successivi).
  
  Inoltre, a volte non è necesssario mostrare l'intera finestra. Guarda quest'esempio:
  
  
  
  Questo screenshot è troppo grande. Ci sono così tante informazioni che sarebbero necessarie intere pagine per descrivere tutte le opzioni illustrate in questa figura. Piuttosto, prova a suddividere l'intera pagina in diversi elementi. Per esempio, la sezione Duration mostrata in questa schermata, oppure la sezione Total Size (che già si era vista nel primo screenshot di questa pagina). Inoltre, non includere MAI il bordo della finestra (la parte blu che contorna tutte le finestre). Serve soltanto a sprecare spazio sullo schermo e occupa più banda Internet del necessario. I lettori non hanno bisogno di vedere la linea con scritto Gordian Knot 0.28.8 (gordianknot.sourceforge.net): sanno già di essere nel Gordian Knot. Il più delle volte puoi fare a meno delle tabs (linguetta su finestra con contenuti multipli, NdT). Basta fare presente che è il momento di passare ad una determinata tab, ed è fatta.
  
  Nel caso tu debba inserire un'immagine piuttosto grande, fai attenzione a quando la ridimensioni. L'esempio che segue è orribile in quanto il testo non si può più leggere agevolmente. Questo è un evidente caso di quando uno screenshot vada diviso in vari elementi. Un possibile modo di suddividere la schermata in vari screenshot è illustrato nella guida a GordianKnot.
  
  
  
  Per ultimo ma non ultimo, le immagini devono essere messe nel luogo giusto: quella che segue è la struttura base di questo sito, il tutto riferito a http://www.doom9.org/
  
  / - documenti che si riferiscono genericamente al sito e tutto quello che si riferisce a AVI/DivX
  /images - immagini che appartengono ai documenti HTML della directory appena sopra citata
  /mpg - tutto quello che si riferisce a MPEG-1/2: VCD, SVCD, DVD±R/W
  /mpg/images - immagini che appartengono ai documenti HTML della directory appena sopra citata
  /DigiTV - tutto quello che si riferisce a DVB / HDTV capturing
  /DigiTV/images - immagini che appartengono ai documenti HTML della directory appena sopra citata
  
  Entrambe le directory delle immagini contengono sotto-directory per i diversi programmi. E' prevista una sotto-directory per ogni programma al quale sono associati un certo numero di screenshot. Se hai a che fare con un nuovo programma, crea pure una nuova directory.
  
  Utilizza dei nomi che ricordino il contenuto di uno screenshot. E' probabile che ti ricordi a cosa si riferiscono nomi come shot1.gif, shot2.gif, etc mentre stai scrivendo il documento, ma tre mesi dopo non puoi dire altrettanto. Non succede su usi dei nomi file che ne suggeriscano il contenuto (a titolo di esempio: la prima immagine usata in questo documento potrebbe avere un nome file tipo gknot-bitrate-sizes.gif, dove chiaramente si capisce che l'immagine appartiene al GKnot, tabella bitrate e che contiene i settaggi sulle dimensioni dei file).
  
  Riassumendo: GIF per materiale di provenienza PC, JPEG per materiale live, PNG se le GIF hanno difetti visibili. Suddividi le immagini, e prova ridimensionarle. Metti le immagini in un path compatibile con l'attuale struttura del sito e usa dei nomi ti permettano di identificare agevolmente le immagini.
  
  Un buon tool per fare screenshot di aree di una finestra senza faticare troppo è Hypersnap DX, oppure l'alternativa freeware: MWSnap.
• I link esterni dovrebbero aprire nuove finestre. Questo sito usa i frames, di conseguenza un link ad un'altra pagina generalmente la apre nello stesso frameset. Quest'azione potrebbe essere considerata scortese e potenzialmente portare ad una azione legale.
• Utilizza i link relativi per ogni contenuto disponibile sul sito. Non ha senso linkare ad un documento che è sullo stesso server, usando un URL assoluto (per esempio http://www.doom9.org/autogk.htm). Al contrario, un link relativo (autogk.htm) andrà benissimo. Lo stesso principio si applica all'archivio software
• Usa gli stylesheet di Doom9 (http://www.doom9.org/doom9.css). In questo modo ci sarà un look coerente per tutti i documenti.
• Utilizza gli stessi elementi di presentazione: Inizia con un titolo in grassetto (stesso dimensione del font come nel resto del testo), quindi una breve introduzione, quindi la lista dei software necessari, quindi la guida suddivisa per punti, i quali inizieranno tutti con un'intestazione in grassetto. Bottoni da premere, opzioni dei menu e gli altri elementi presenti sugli screenshot vanno scritti in corsivo.
  Ovviamente, se stai scrivendo un documento che andrà integrato in una guida esistente, non saranno necessari l'introduzione e la lista del software, ma i vari punti andranno numerati in modo tale che siano coerenti con l'intera guida, una volta che l'integrazione sia stata effettata.





Tradotta da zanzarameil 25/06/04