venerdì 11 aprile 2008

Pubblicazione di documenti

Alcune indicazioni sulla pubblicazione di documenti sul sito web.

Numero di versione: ogni documento deve avere un numero di versione ed una data. I documenti che dipendono da altri, come il caricamento dati dipende dallo schema, devono specificare la/le versioni del documento da cui dipendono rispetto alla quale sono validi.

Storia delle modifiche: ogni documento è accompagnato da un "change log". Quando producete una nuova versione di un documento, aggiungete in testa al change log una descrizione sintetica che spiega in che modo la nuova versione differisce da quella immediatamente precedente.

Formato: per ogni documento è bene pubblicare almeno una versione che si possa leggere online con un solo click (ad esempio, un .pdf). È utile inoltre la possibilità di raggiungere in un click lo schema concettuale della specifica dei requisiti. L'uso di altri formati (formati compressi, modificabili, che raggruppano più files in uno) è opzionale, ma sono benvenute richieste in proposito.

Responsabilità congiunta: chi invia il documento ha la responsabilità di produrre oggetti leggibili, senza virus, e immediatamente pubblicabili. I gestori del sito web hanno la responsabilità di fare un ulteriore controllo, a posteriori o a priori, sul fatto che i documenti pubblicati si aprano senza provocare errori.

GG

1 commento:

Giorgio Ghelli ha detto...

Scordavo: per la versione dei documenti pubblicata in questo momento non è richiesto nessun change-log; cominciate con la prossima versione.