| Documenti Firebird → Agli scrittori per Firebird → Scrivere documenti per Firebird |
|
|
|
Traduzione in italiano: Umberto Masotti
Ottobre 2006 – Versione 1.2.1-it - prima versione italiana
Sommario
Questa guida mostra i vari aspetti della scrittura di documenti per il progetto Firebird. È stata scritta per coloro che intendono aiutare a scrivere documenti per il progetto Firebird, o che considera di farlo. Dopo aver letto questa guida si hanno le conoscenze necessarie per scrivere i documenti nel formato da noi scelto, cioè DocBook XML.
Prima di leggere questa guida, bisogna avere una certa padronanza su:
che cos'è il modulo del manuale di Firebird.
che cos'è CVS, e come si usa un CVS client per scaricare il modulo del manuale ultima revisione.
come costruire la documentazione a partire da modulo scaricato.
Questa conoscenza è fondamentale per poter contribuire al nostro progetto di documentazione. Se non si è sicuri riguardo ad uno o più di questi punti, sarebbe meglio leggere prima Come scaricare e ricostruire il modulo del manuale di Firebird, e poi proseguire la lettura.
Si inizia con argomenti rapidi quali:
La mailing list firebird-docs.
Selezionare un argomento.
Fare una traccia dell'organizzazione del documento.
Dopodichè ci sarà una lunga digressione sui fondamenti del DocBook XML, perchè in quel formato andranno preparati i documenti. Gli argomenti trattati saranno:
Che cos'è DocBook XML?
Ragioni per preferire DocBook così fortemente rispetto ad altri formati.
Strumenti utili per produrre testi in DocBook.
Anche se la parola "DocBook" non significa ancora molto ancora, la necessaria abilità potrà essere acquisita in meno di un'ora, e ci saranno possibilità per cui si potrà beneficiare di queste capacità per altri progetti, dovunque ci sia da scrivere documentazione tecnica.
La parte successiva riguarda il vero e proprio modo di scrivere per DocBook:
Impostare il documento.
Usare gli elementi di DocBook.
Una parola o due sul linguaggio e lo stile di scrittura.
I diritti d'autore (Copyright) and la Licenza di Pubblica Documentazione (Public Documentation License).
Infine, si mostra come aggiungere il documento finito al progetto Firebird. Gli argomenti principali in questa sezione sono:
Inviare il documento finito al modulo del manuale.
Dove chiedere per i diritti di invio se non ce li hai.
Cosa fare e cosa non fare una volta ottenuti i questi diritti.
|
| Documenti Firebird → Agli scrittori per Firebird → Scrivere documenti per Firebird |