PDA

Visualizza la versione completa : Documentazione software


3millennium
01-06-2005, 13:56
ciao a tutti...non vi sto chiedendo software per fare della documentazione ma un insieme di regole da usare per fare della buona documentazione...qualcuno mi sa aiutare?

xegallo
01-06-2005, 14:00
non farla fare a chi sviluppa il software

3millennium
01-06-2005, 14:01
io sviluppo ma devo fare la documentazione di un software fatto da un collega...piccolo problema...non so se x documentazione intende un semplice help oppure un vero e proprio documento con tanto di analisi dei requisiti, diagramma delle classi etc etc etc

rebelia
01-06-2005, 14:02
Originariamente inviato da 3millennium
io sviluppo ma devo fare la documentazione di un software fatto da un collega...piccolo problema...non so se x documentazione intende un semplice help oppure un vero e proprio documento con tanto di analisi dei requisiti, diagramma delle classi etc etc etc

chi e' il destinatario della documentazione? l'utilizzatore o il responsabile acquisti?

3millennium
01-06-2005, 14:09
mi hanno detto che dovrebbero risultare sia un documento tecnico sia un help...quindi credo entrambi...io mi sto informando sull'uml...dite che mi servirà??? mah...male che vada è una cosa in + che so :D

galz
01-06-2005, 14:11
Originariamente inviato da 3millennium .io mi sto informando sull'uml...dite che mi servirà??? mah.. :oVVoVe: Ohhhh... una cifra... :stordita:

rebelia
01-06-2005, 14:13
Originariamente inviato da 3millennium
mi hanno detto che dovrebbero risultare sia un documento tecnico sia un help...quindi credo entrambi...io mi sto informando sull'uml...dite che mi servirà??? mah...male che vada è una cosa in + che so :D

dividi le due cose, mettile in due capitoli diversi o quello che vuoi: la roba tecnica per chi ci capisce, la spiegazione da utonti per chi l'utilizza e se puoi fai provare il programma ad un utonto e man mano che procede scrivi, cosi' ti rendi conto delle difficolta' e delle cose da non dare per scontate

3millennium
01-06-2005, 14:23
beh si...i documenti li terrò proprio distinti...prima le cose tecniche e poi la cosa x la plebe ;) o viceversa?
nella giuda devo mettere eventuali vincoli? esempio: inserire la password (la password deve essere lunga massimo 3 caratteri ed essere composta da soli numeri 3) (una cosa sicura insomma :D)

rebelia
01-06-2005, 14:27
Originariamente inviato da 3millennium
beh si...i documenti li terrò proprio distinti...prima le cose tecniche e poi la cosa x la plebe ;) o viceversa?
nella giuda devo mettere eventuali vincoli? esempio: inserire la password (la password deve essere lunga massimo 3 caratteri ed essere composta da soli numeri 3) (una cosa sicura insomma :D)

prima la roba tecnica e si, metti TUTTI i vincoli e anche tutto il resto che ti viene in mente (non dare niente per scontato, insomma): l'utilizzatore finale te ne sara' grato e ti fara' buona pubblicita' e tu eviterai di ricevere tremila telefonate di richiesta di spiegazioni

3millennium
01-06-2005, 14:46
mmm...considerando che probabilmente sarà il mio ultimo lavoro quì beh...quasi quasi lo faccio male così si ciucciano le telefonate :D
scherzi a parte, ci sono delle regole base da seguire o è tutto a libera interpretazione?

Loading