Where can I find information on how help files are created?

Question

I'm writting a paper for my intro programming class and need some general info. Thanks.

Answer 1

Help files are usually just text files that include information relating to the program.

You can put them on HTML pages to allow them to be updated regularly - and as long as the user is online, they can have access to the most up-to-date information regarding their program.

I have found it is better to write programs that are simpler, and more self-explanatory - this keeps people from having to dig through help files just to figure out how to use the program. Obviously what seems simple to you might be difficult for someone else, but that is why you should always have a couple of beta testers to help you out - get at least one or two that aren't necessarily that computer literate - that way you will see how intuitive your program is.

A lot of programmers fault the user when they complain about not being able to figure out how to do something - but I believe it is up to the programmer to make their program as self-explanatory as possible. Obviously you can't help some people - but the majority of really successful programs have one thing in common - they are easy to use.

Answer 2

This Wikipedia article might be a good place to start if looking at how to make a compressed HTML help file (.chm). Help files could also be created as part of a Hyper Help system, Adobe PDF, HTML pages, or even a simple text file. Now if you are asking specifically how to create the contents of a help file, that all depends on what you are writing a help document on. Is this for using an application, administration, trouble shooting, software APIs, etc...? Not sure where to go without a more specific question.