Firebird Documentation Index → Scrivere documenti per Firebird → Prepararsi a scrivere: farsi uno schema! |
Sarebbe bene farsi sempre uno schema di quello che si intende scrivere, prima di iniziare. Farsi uno schema aiuta ad «organizzarsi»; riduce la possibilità di dimenticarsi qualcosa d'importante, e rende un po' più semplice l'effettiva scrittura del documento.
Si può seguire questa procedura nel farsi uno schema:
Definire esattamente cosa si desidera che i lettori imparino dal proprio lavoro.
Dividere il lavoro in unità logiche - tipo capitoli, sezioni, sottosezioni ecc.
Assicurarsi che l'ordine delle unità logiche abbia un senso, specialmente per i manuali, le esercitazioni, le guide per l'utente. Sarebbe a dire: strutturare le varie unità in modo tale che qualunque cosa il lettore debba fare o capire prima, sia anche prima nella documentazione scritta.
Una volta pronto, è bene presentare lo schema alla lista firebird-docs su sourceforge.net per chiedere commenti.
Una volta che lo schema è pronto e revisionato, lo si ricontrolla per determinare se si hanno tutte le informazioni necessarie per scrivere. Sarebbe bene avere tutte le informazioni pronte prima di iniziare la scrittura, perchè talvolta un'informazione non ben conosciuta all'inizio potrebbe comportare una struttura diversa del documento. Sarebbe stato meglio allora avere quell'informazione nella fase di preparazione.
Firebird Documentation Index → Scrivere documenti per Firebird → Prepararsi a scrivere: farsi uno schema! |