Re: Delphi Help systems

Posted by webmaster Guido on August 30, 2002 at 05:32:40:

In Reply to: Help systems posted by Josche Stewart on August 12, 2002 at 10:33:22:

: What are some important guidelines that should be considered when developing help systems?
----------------------

Well ;-) you're not asking for a tip, but for an entire tutorial ;-) ...impossible in a few words, so just a few tips:

Have a clear outline in your chapters:
1. What does the thing do? What are the main features? Maybe include: why use it?
2. Quick start.
3. Explanation of the menu's (if any).
4. More details about the features.
5. Maybe add a FAQ
6. Some advanced tips and tricks.
7. Where to go for more support (if any).

Have enough keywords, but not too many ;-)

If there are a lot of screens/ menu's/ controls: have some context-sensitive help.

But above all: learn from good examples. Study help systems that you think are well done.

Search the www, there are *tons* of advice on this subject :)