Genera documenti in build automatizzata

Question

Esiste un modo per generare documenti di progetto durante build automatizzate?

Vorrei avere un singolo set di file sorgente (HTML?) con il manuale dell'utente e da loro generare:

• documento PDF
• Guida CHM
• Versione HTML della guida

Il contenuto sarebbe sostanzialmente lo stesso in tutti e tre i formati.

Attualmente sto usando msbuild e CCNET, ma potrei cambiarlo se necessario.

Answer 1

Sì!

• Utilizza SandCastle per creare la documentazione CHM / HTM delle API.
• Utilizza DocBook + FOP e altri strumenti per produrre altri tipi di documentazione in PDF, RTF, HTML ecc ...

Possono essere facilmente integrati con CruiseControl.NET tramite NAnt .

Answer 2

Hai provato doxygen ? È disponibile anche per Windows e dovrebbe essere facile integrarlo in qualsiasi script / processo di compilazione.

Answer 3

Il progetto Apache Forrest potrebbe in qualche modo darti quello che vuoi.

In genere sarà meglio scrivere la documentazione in XML. Da ciò dovresti essere in grado di generare praticamente tutto ciò di cui hai bisogno.

Answer 4

Aiuto e Manuale possono generare PDF, HTML e CHM (e altri formati) di buona qualità da una singola fonte. Ha anche un'interfaccia a riga di comando. Ho la versione 4 e mi piace molto. Uso condizionali (come #ifdefs) per generare versioni Windows e Mac della mia documentazione in vari formati come parte di un file build .bat / .csh. La versione 5 è ora disponibile.

http://www.ec-software.com/

Answer 5

Se vuoi che anche la tua API sia documentata e stai usando msbuild, allora considera l'utilizzo di DocProject per controlla la SandCastle . (Questi strumenti non sono per la documentazione per l'utente finale ...)

Answer 6

Ho avuto un'esperienza con Doxygen. È bello e facile, ma ti fa venire voglia di superare il codice per facilitare il lavoro di documentazione successiva.