How to manage end-user documentation for a project with ongoing integration?

Question

I have a project under continuous integration and would like to add end-user documentation to the project. End-user documentation is a user guide, not an API documentation. In our environment, we use windows, C #, msbuild, cruisecontrol.net and subversion. We are currently using DocToHelp to create our help file based on the msword document.

I am looking for some guidance on managing end-user documentation. What documents tools should be used? Should any of the documentation tools be part of the script assembly? Should output files from the documentation tool be stored in a disruptive program? What types of help files are best used?

Answer 1

XMLMind XML Editor docbook, 6 . XSL docbook HTML PDF. , .

, .

Answer 2

, Doxygen: http://www.stack.nl/~dimitri/doxygen/

Doxygen - ++, C, Java, Objective-C, Python, IDL (Corba Microsoft flavors), Fortran, VHDL, PHP, #

Answer 3

DocToHelp, :

, : , .

, Word, , CI-. CI- , .

(, ?), , ( ).

Basically, your CI server will then prove whether it can play your help file from version control (did you complete and add everything?). Taking even more, you can create automated tests that will check the assembly help file and compare it with the specified help identifiers in the software itself. But here I reflect (I did not do help files at the age of :-)).