Re: Pre-requisites for Help Documentation

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

To keep it very simple I'd look at two things:

1	Screen help - what does each screen do? What are the fields?
What are valid values etc. May include links to other related screens
and topics that provide background information

2	Task help - what will the user be using the application for and
then provide step by step instructions. Remember this is a bit like
creating an index and you need to think of what the user may call the
task and cover all the possibilities.

This is VERY basic - once you've got that there's context sensitive help
etc that can be looked at.


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


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

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
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.