4. Scrivere e proporre un HOWTO

Se siete interessati alla scrittura di un HOWTO o mini-HOWTO, cercate di contattarmi PRIMA!!! a linux-howto@sunsite.unc.edu.

Ci sono alcune linee guida che dovreste seguire quando scrivete un HOWTO o mini-HOWTO:

• Usate una struttura ed organizzazione dell'HOWTO che sia coerente, e scrivete in modo chiaro. Ricordatevi che la maggior parte di chi consulta gli HOWTOs non parla l'inglese come lingua madre.
• Se state scrivendo un HOWTO, dovete usare il pacchetto Linuxdoc-SGML, che trovate a http://www.sgmltools.org/, per formattare l'HOWTO. Questo pacchetto vi permette di produrre LaTeX (per dvi e PostScript), testo normale, HTML e altri formati da un singolo documento sorgente, sviluppato da Matt Welsh specificatamente per gli HOWTO. Conferisce, inoltre, un look uniforme agli HOWTO. È importante verificare che gli HOWTO si formattino e si leggano bene in PostScript, testo semplice e HTML.
• Se state scrivendo un mini-HOWTO, potete usare sia SGML (come scritto sopra) o HTML. Se si usa SGML per il proprio mini-HOWTO, questo sarà pubblicato assieme agli HOWTO nei libri di LDP.
• Assicuratevi che tutte le informazioni siano corrette. Non si sa mai abbastanza. Se siete in dubbio, confrontatevi, ma mettete in chiaro che state solo provando.
• Controllate di usare la versione più recente del software. Pertanto, assicuratevi di includere le istruzioni complete su dove scaricare il software (sito FTP, percorso completo), la versione corrente e la data di rilascio del software.
• Includete una sezione per le FAQ alla fine (se serve). Alcuni HOWTO hanno bisogno di una sezione ``FAQ'' o ``Problemi Comuni'' per fornire le informazioni che non si possono dare all'interno del testo normale.
• Usate gli altri HOWTO come modello. Il sorgente SGML dell'HOWTO lo trovate nei siti FTP Linux. Inoltre si dia una occhiata alla LDP Style Guide per alcune regole basilari.
• Assicuratevi che il vostro nome, indirizzo email, data e numero di versione siano all'inizio del documento. Potete anche includere indirizzi WWW ed email se volete. L'intestazione standard è:

          Titolo
          Nome e email dell'autore
          Numero di versione e data
          
  

  per esempio:

          Linux HOWTO Index
          di Tim Bynum
          v2.10.29, 31 luglio 1997
          
  

• Infine, preparatevi a ricevere domande e commenti sui vostri scritti. Ci sono centinaia di accessi al giorno alla collezione degli HOWTO da tutte le parti del mondo!

Dopo che avrete completato l'HOWTO, speditemelo. Se avete usato Linuxdoc-SGML, speditemi solo il sorgente SGML; mi prenderò cura io stesso della formattazione del documento. Inoltre provvederò ad archiviarlo in sunsite.unc.edu e lo spedirò ai vari newsgroups.

È importante che voi passiate attraverso di me quando pubblicate l'HOWTO, visto che mi preoccupo di mantenere gli archivi ed ho bisogno di sapere quali HOWTO sono stati scritti e conoscere cosa si sta già facendo.

Poi, tutto ciò che dovrete fare è mandarmi periodicamente le vostre revisioni.