436 messaggi dal 08 febbraio 2009
Buongiorno.

In linea di massima un buon software deve avere due documentazioni:
- Quella di sviluppo (come sono strutturate le classi, quali metodi, ...)
- Quella per il cliente (come si inserisce un cliente? Come si fa un DDT?, ...)

Per quella di sviluppo ho visto che ci sono un sacco di tool che la generano in automatico dai commenti scritti nel codice e va benissimo.

Per creare la documentazione da dare all'utente finale, invece, quali sono i software più utilizzati?

Tanto per capirci.
Finchè si tratta di un software piccolo (un paio di videate), un PDF ben strutturato basta e avanza.

Quando però il software inizia a diventare di dimensioni più ampie, l'affare si complica.
Per esempio si deve documentare come inserire i clienti, i fornitori, gli articoli, i DDT... E spesso da una documentazione si deve richiamare l'altra (in inserimento di un acquisto, se manca l'articolo bisogna inserirlo).

Ci sono software che consentono di gestire queste cose?

Ho provato un po' coi Wiki, però li trovo molto scomodi da usare, soprattutto per scrivere la documentazione.
10.265 messaggi dal 09 febbraio 2002
Contributi
Ciao,
forse la scelta più versatile consiste nello scrivere la documentazione in una "lingua franca" come il Markdown.
Se usi un editor di Markdown come Remarkable avrai l'opportunità di esportare la documentazione come PDF o come HTML.

Un'alternativa è Gitbook editor e anch'esso consente di convertire in html e pdf usando un tool da riga di comando. E' da tenere d'occhio ma per il momento lo eviterei, almeno finché il suo team di sviluppo non risolve la crisi d'identità che sta attraversando.

Oppure puoi affidarti a servizi online come ReadTheDocs ma ha un costo non indifferente.

Ah, e metti tutto sotto controllo di versione.

ciao,
Moreno
Modificato da BrightSoul il 31 agosto 2017 22.44 -

Enjoy learning and just keep making
112 messaggi dal 22 gennaio 2017
Contributi
Io ho approfondito l'utilizzo della wiki negli ultimi mesi.
Ho trovato questo https://wiki.js.org/ , molto interessante, soprattutto perchè sfrutta il formato markdown e non il formato standard delle wiki.
Come guida di massima per l'utilizzatore potrebbe essere arricchita anche da immagini e GIF animate. Il tempo maggiore per questi strumenti è la redazione della documentazione e la conoscenza di chi deve realizzarle.
Il formato markdown non è immediato soprattutto per una persona che non ha un backgroud tecnico.

Per la documentazione del codice, avevo trovato uno strumento molto carino nei mesi scorsi. Mi ha piacevolmente sorpreso perchè genera una SPA in angular 2 con mappe interattive.
http://sharpdox.de/
Un esempio: http://sharpdox.de/de/doc/#/type/SharpDox.Model.KnownReferences/index
Modificato da andrea.tosato86 il 03 settembre 2017 12.06 -

Torna al forum | Feed RSS

ASPItalia.com non è responsabile per il contenuto dei messaggi presenti su questo servizio, non avendo nessun controllo sui messaggi postati nei propri forum, che rappresentano l'espressione del pensiero degli autori.