What type of documentation suite to create?

Subject: What type of documentation suite to create?
From: "Nadine Underwood" <nadine -dot- underwood -at- orchard-systems -dot- co -dot- uk>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 16 Jun 2004 14:16:32 +0100


I need to create some documentation for a new product. The documentation
needs to include:

* Sections on the "basic tasks" for everyday users of the system -
procedural, step-by-step instructions with screen shots to illustrate
* Sections on "advanced tasks" for more advanced users
* Sections on technical system architecture for techies

Now, I can't make up my mind whether to have 3 separate documents, or
one manual with the three separate parts divided by tabs. I am uneasy
about putting them all together, as the novice users who just need the
basic tasks sections, will be put off when they see the size of the
thing and some of the more technical aspects of it. However, if I was to
keep it separate they would be duplication as the basic tasks would need
to be included in the advanced tasks sections.
Any thoughts, comments would be appreciated.
Thanks, Nadine

Nadine Underwood
Orchard Information Systems Limited, Newcastle Technopole,
Kings Manor, Newcastle upon Tyne, United Kingdom.
Registered in England, 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/>


SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .

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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.

Previous by Author: Re: Formats for cross-platform documentation?
Next by Author: List of variables in FrameMaker
Previous by Thread: Re: Disburse or Disperse
Next by Thread: re Disburse or Disperse

What this post helpful? Share it with friends and colleagues:

Sponsored Ads