renareto” post=76860Ciao a tutti,
nel posto dove lavoro (una softwarehouse), devo sviluppare un manuale (una parte via…:smile: ) del prodotto di questa azienda, che è un sw molto complesso in termini di “feature”.Visto che sono un amante di latex, mi sono detto: esisterà qlc cosa che mi permetta di:
– redigere il manuale
– averlo in .pdf
– ma soprattutto consentire l’ aggiornamento facilmente anche a chi non è esperto.Pensavo ad una cosa del genere:
I contenuto in un DB, facilmente aggiornabile e la forma in latex.Sto dicendo una castronria?
Grazie
Renato
No. Secondo me non dici castronerie. Però…
Il testo tuttavia, potrebbe dover contenere mark up, per esempio per enfatizzare una parola, ed il mark up finirebbe anch’esso nel db.
Tanto vale lasciare in chiaro il contenuto realizzando al posto di un database una classe di documento con le impostazioni necessarie, che poi carichi i file necessari.
Invece di lavorare con lo scomodo db, si lavora con i classici file di testo, molto semplici da aggiornare ed archiviare.
Anzi, potresti pensare di utilizzare un repository git su cui caricare i commit, utile per un lavoro di gruppo, oppure pensare di scrivere il manuale direttamente nei sorgenti, per esempio come javadoc, “literate programming”.
Uno script ad hoc, potrebbe ricavare i sorgenti LaTeX direttamente dal codice. L’onere della gestione delle revisioni sarebbe risolto automaticamente dal sistema di gestione dei sorgenti, mentre lo sviluppatore è quello che conosce al meglio il software, e scrivendone la documentazione potrebbe lui stesso ricavarne utili miglioramenti.
In generale, terrei il testo in file di testo, eventualemente gestendo un repo su db per il controllo delle revisioni.
R.