Discussion Locked

Online Manual

0 helpful
6 replies
Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.
How to create online manual?

6 replies

by albert franco ii

The four most popular formats are Windows Help (only windows systems), Word DOC file (for windows and Mac), pdf files (for just about any system) and HTML (good for most platforms that have internet connectivity).

You need to decide if the readers will all use the same platform or several. If it is several then get Adobe Acrobat and write your manual (you can include screen shots and pictures) and include it in the distribution CD or file. Anyone one with Acrobat Reader can open it. And Acrobat Reader can be distributed free along with your manual.

If all of your users are Windows and Mac users and they have Word or Word reader then you can do the same using MS Word. (I prefer Word Perfect but MS is a cancer and everybody's got it.) NOTE: There are sometimes problems opening a Win Doc on Mac and visa versa. But generally it goes smoothly.

If your manual is very technical and can also serve as on-line help and your program is a Windows application then your can construct it with programs like DotHLP (http://www.helpfile-builder.com/Winhelp/prod01.htm) or a very decent product from Rimrock Software, HelpGen (http://www.rimrocksoftware.com/helpgen.html) .
For more info on Windows help files check this link: http://ourworld.compuserve.com/homepages/RHendricks/whelpdev.htm

The last option mentioned is HTML. You can produce a web site type structure for your manual and distribute it to anyone that has a browser or even tie it into the new Windows Help system.

A downside of HTML and WinHelp is that they usually don't print well. Word and pdf files however produce very nice printed versions.

There you are. Of the four options I'd choose the pdf. Acrobat isn't cheap but it produces the most professional and easily distributed files around.

Good Luck,
Al Franco, II
APF Creations
Pamplona, Spain

by albert franco ii

That explains the technical side of the manual or in other words the packaging. As for the Content it depends very much on your audience and the product.

In general a manual should include
Copyright notices and disclaimers,
a table of contents,
an introduction to the product,
An overview of its uses,
Detailed chapters as to How to use it,
A bibliography and/or suggestions where the reader can find more information on the field in general
and aplications of your product, and finally an index.

If you need more help contact me at apf2@apf2.com

This discussion is closed to new replies.