Re:Content of Help Systems

["Damien Braniff" <Damien -dot- Braniff -at- asg -dot- com>]

To me, the primary aim of Help is just that - to provide help here and
now. This may be anything from what goes in this field to how do I
insert a table etc. While it should be mainly How to... there is an
argument for providing additional information. It may not be enough to
have a set of steps - complete fields x, y and z and press Enter -
without some background on what can go in fields x, y and Z, especially
if there are dependencies. For example, if x is... then y can be...
otherwise.

In addition some people LIKE to have additional information (what do
your customers want?). I'd tend to go for:
How to procedural info (with pop-ups for additional info that may be
required at each stage)
Related topics for... related topics :-)
See also links background material if appropriate (plus ref User Guides
as well for those who prefer books!)

Damien Braniff | Technical Writer
damienb -at- asg -dot- com 
Technical Communications
ASG | asg.com
Waterfront Plaza
8, Lagan Bank Road,
Belfast, N. Ireland BT1 3LR 
Tel:  +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324
End-to-End Technology Management



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.