4. Scrivere e proporre un HOWTO

Se si è interessati a scrivere o mantenere un HOWTO, PRIMA!!! si cerchi di contattarci a ldp-discuss@lists.linuxdoc.org.

Se si vuole mantenere un HOWTO non più mantenuto, si provi a contattare anche il vecchio autore.

Si consulti HOWTO-HOWTO per informazioni dettagliate sulla scrittura e la proposta di un HOWTO.

Ci sono alcune linee guida generali che si dovrebbe seguire quando si scrive un HOWTO:

• Si utilizzi una struttura ed organizzazione dell'HOWTO che sia coerente, e si scriva in modo chiaro. Si ricordi che la maggior parte della gente che consulta gli HOWTO non parla l'inglese come lingua madre.
• Ci si assicuri che tutte le informazioni siano corrette. Non si sa mai abbastanza. Se si è in dubbio, ci si confronti, ma si metta in chiaro che si sta solo provando.
• Si controlli di usare la versione più recente del software. Pertanto, ci si assicuri di includere le istruzioni complete su dove scaricare il software (sito FTP, percorso completo), la versione corrente e la data di rilascio del software.
• Si includa 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.
• Gli HOWTO dovrebbero esserci proposti in SGML DocBook o linuxdoc. Si faccia riferimento a HOWTO-HOWTO per maggiori informazioni.
• Use other HOWTOs a model. The SGML source to + the HOWTOs is available on Linux FTP sites. In addition, examine the + HOWTO-HOWTO, the + LDP manifesto (and license guide), and the + Using DocBook HOWTO.
• Si usino gli altri HOWTO come modello. Il sorgente SGML dell'HOWTO lo si trova nei siti FTP Linux. Inoltre si dia una occhiata a HOWTO-HOWTO, al manifesto di LDP (e alle regole di licenza) e a Using DocBook HOWTO.
• Ci si assicuri che il proprio nome, indirizzo email, data e numero di versione siano all'inizio del documento. Si possono 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, ci si prepari a ricevere domande e commenti sui propri scritti. Ci sono centinaia di accessi al giorno alla collezione degli HOWTO da tutte le parti del mondo!

Dopo che si è scritto l'HOWTO, si invii a noi il sorgente SGML a ldp-submit@lists.linuxdoc.org.

È importante che si passi attraverso di noi quando si pubblica l'HOWTO, visto che noi ci preoccupiamo di mantenere gli archivi ed abbiamo bisogno di sapere quali HOWTO sono stati scritti e di conoscere cosa si sta già facendo.

Poi, tutto ciò che si dove fare è spedirci periodicamente le revisioni.