The Design of Software (CLOSED)

A public forum for discussing the design of software, from the user interface to the code architecture. Now closed.

The "Design of Software" discussion group has been merged with the main Joel on Software discussion group.

The archives will remain online indefinitely.

Help Files

Can anybody recommend a good program for creating help files that compile as CHM and can be output for the web? I have the microsoft SDK for creating help files but I want something that has a gui interface for creating the files.
Ben Send private email
Friday, July 01, 2005
 
 
Depends how much you want to spend. We are currently using doc-o-matic seem to do everything we need, and loads more, but it is quite expensive.
Ian H. Send private email
Friday, July 01, 2005
 
 
We use Help & Manual ( http://www.ec-software.com ) and would highly recommend it. As well as producing the usual formats (hlp, chm), the same source can also produce PDF manuals as well as plain HTML for use on your web site.
Ewan McNab Send private email
Friday, July 01, 2005
 
 
+1 for Help & Manual

Because you learn it quickly and can output to many formats.

I have also used CityDesk for this. It produces CHM and html files easily.
Dimitris Giannitsaros Send private email
Sunday, July 03, 2005
 
 
Another +1 for Help & Manual.  I've been really happy with it.
Boofus McGoofus Send private email
Sunday, July 03, 2005
 
 
http://www.helpmaster.com/ provides a thoroughly complete overview over WinHelp/HTML Help editors. You might also want to re-read a previous discussion of the same topic on JoS,
http://discuss.joelonsoftware.com/default.asp?joel.3.17274.4

I ended up with HelpNDoc due to its intuitive user interface
(plus it is free), but this just creates CHM files.
http://www.ibe-software.com/products/software/helpndoc/
- Roland
Monday, July 04, 2005
 
 
Roland,

According to their website, HelpNDoc is only free if it is for personal use and 'you can't use HelpNDoc or its generated files for profit.' - otherwise a license is 45 Euros. According to the site, it also puts some text at the bottom of each help page.

It does look like a good product, however.  I'm looking to write a few help files for internal company apps and will probably download the free/demo version to check it out.
RocketJeff Send private email
Monday, July 04, 2005
 
 
HelpMaker from http://www.vizacc.com/.  FREE!  Works great!
Helpful
Friday, July 08, 2005
 
 
You may also look at another help authoring software, Dr.Explain, which is built on the brand new technology.

Dr.Explain captures windows from a live application, creates screenshots and automatically adds references to all window’s controls: buttons, edit fields, radio buttons, dropdown lists, and other elements. You must just add some description if needed. This considerably reduces the time of documenting the application’s graphical user interface.     

I invite you to look at the project at http://drexplain.com 
I hope you will find the concept interesting.
Dennis Crane Send private email
Tuesday, July 12, 2005
 
 
This depends on what type of help file you are generating...

If it's an automatically generated code document that you want (i.e. APIs etc) then I would recommend:
NDoc for C# and VB.NET
or
DOxygen for C, C++ (and several others with a filter)

If it is for you to generate a document for a program then look at:
HelpMaker - it's free for commercial use and generates several formats. It has a few minor funniocities but once you are used to it, it is nice enough to use.

Saturday, July 16, 2005
 
 

This topic is archived. No further replies will be accepted.

Other recent topics Other recent topics
 
Powered by FogBugz