Come scrivere la documentazione?

[Ghepardo]

Ragazzi, volevo chiedervi dei piccoli consigli sul come dovrebbe essere organizzata/strutturata la documentazione di un software. Devo scrivere la documentazione di un progettino che sto facendo per un'esame all'università, ma nessuno ci ha mai spiegato come dovrebbe essere fatta.

Spero voi possiate aiutarmi a capire.

E' fatto in java quindi includerà le javadoc e ci siamo...ma il resto ?

[Alvaro Vitali]

Ma devi farla in modo rigoroso utilizzando un linguaggio di modellazione tipo UML e quindi hai progettato il software passando per tutti gli stadi Analisi, Design etc... o solo fornire una documentazione che descriva ciò che hai fatto?
Mi sembra strano che chiedano una documentazione senza averti spiegato di cosa si tratta, di che esame si tratta? :eek:

[Ghepardo]

progetto di reti di calcolatori.

no, non abbiamo progettato il software con uml etc, il progetto riguarda una directory condivisa quindi cera poco da progettare con uml.

cmq non deve essere proprio rigorosa...

[Alvaro Vitali]

Messa in questi termini credo che ti debba compilare una documentazione scritta che copra su per giù questi paragrafi:

- Titolo :D
- Obiettivi
- Linguaggi e strumenti utilizzati
- Istruzioni (tipo come avviare il server ed i client)
- Protocollo utilizzato
- Descrizione dettagliata
-- Il Server
-- Il Client

Ioa llegherei un diagramma di flusso alla buona giusto per una schematizzazione della comunicazione client server dove mettere in parallello il flow della comunicazione.
Tipo col server che fa socket->bind->listen-> ->accept->send->recive
ed il client in parallelo che socket -> connect ecc...ecc.. ovviamente relativo alla tua applicazione...
Che ne dici?
Ciao! ;)

[recoil]

di che l'hai scritta in latex, fa sempre un certo effetto :O

i diagrammi UML li ho usati spesso ma in progetti che riguardavano le basi di dati.
dipende da che cosa hai fatto nel progetto. parli di directory condivisa ma esattamente che hai fatto?

lo schema di Alvaro Vitali, a cui rinnovo i miei complimenti per l'interpretazione magistrale di Gian Burrasca, direi che è un buon punto di partenza