Advice on structuring a Help File

[Nadine Underwood <nadine -dot- underwood -at- orchard-systems -dot- co -dot- uk>]

Hi,

I am in the process of creating on-line release notes for a software
application release and need some advice. The developers have structured the
release notes as below:

Title 
1. Overview of Contents (what the software change is)
2. Accessing the Functionality (how to find it in the system)
3. User Instructions (what the user should do when they have found it)
4. Set-Up Requirements (single title)
4a. Programs (list of programs which need setting up - sometimes with
instructions on how to do it)
4b. Parameters (list of parameters which need setting up - sometimes with
instructions on how to do it)
4c. Batch Programs (list of batch programs which need setting up - sometimes
with instructions on how to do it)

I have structured my help file as follows:

Chapter: Title and then the overview on the same page - obvious
Section 1: User Instructions - 1 page incorporating "Accessing the
Functionality" and "User Instructions" as they follow on from each other and
are one of the same thing - they are also what the 'user' needs to know
Section 2: Set-Up Instructions - single page with just the heading on
Section 2a - Programs - as their 4a
Section 2b - Parameters - as their 4b
Section 2c - Batch Programs - as their 4c

Now the question is - where do I put the set-up instructions? What do I call
them? Can you think of anything better? Does it matter that all the titles
are the same? (Will the user of the help-file know where they are in it??)

Nadine

___________________________________________________________
Nadine Underwood
Orchard Information Systems Limited, Newcastle Technopole, 
Kings Manor, Newcastle upon Tyne, United Kingdom.
Registered in England, Company Number 1900078
Tel: +44 (0)191-203 2500 Fax: +44 (0)191-230 2515
http://www.orchard-systems.co.uk <http://www.orchard-systems.co.uk/> 



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

ANNOUNCING ROBOHELP STUDIO

RoboHelp Studio maximizes your Help authoring power by combining 
RoboHelp Office and RoboDemo, so you can easily create professional 
Help systems that feature interactive tutorials and demos.

Find out more about RoboHelp Studio at http://www.ehelp.com/techwr-l2

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