[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[linux_var] R: Re: Testo per scrittura specifiche tecniche



>Da: jacopogg83@gmail.com
>Data: 29/12/2013 15.57
>Innanzitutto una domanda: questo lavoro di documentazione servirà in futuro a
>qualcuno? Servirà a qualcun'altro eccetto te? Ha valore per l'azienda?

La documentazione ha valore per l'azienda che è assolutamente concorde nel
farla. Non mi ci devo insomma dedicare a tempo perso. In teoria dovrà servire
come riferimento a me o a chiunque in futuro dovesse mettere mano
all'applicazione.

>Per il resto, che genere di manualistica devi scrivere, devi documentare 
delle
>API per dei programmatori o delle funzioni per degli utenti finali? Qualche

Sicuramente dovrà aver un taglio tecnico (come se fossero specifiche da
passare a degli sviluppatori): gli utenti conoscono l'applicazione meglio di 
me.

>manuale l'avrai letto, quindi un'idea anche vaga di come scriverlo potresti
>averla. Descrivere lo scopo dell'applicativo, le sezioni in cui è diviso, le

Il problema è passare dalla teoria alla pratica. Alcuni spunti interessanti li 
ho
trovati in "Working effectively with legacy software", ma quel testo affronta 
il
problema tramite unit test che non sono possibili nel RAD usato in azienda e
sono comunque un passo successivo a quanto devo fare ora. In effetti il mio
problema è più nel campo del software "legacy" che non in quello della
documentazione.

http://www.objectmentor.
com/resources/articles/WorkingEffectivelyWithLegacyCode.pdf

_______________________________________________
Talking mailing list
Talking@ml.linuxvar.it
http://ml.linuxvar.it/cgi-bin/mailman/listinfo/talking