Re: Your TECHWR-L message

Subject: Re: Your TECHWR-L message
From: Carr <obair81 -at- comcast -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 Jun 2004 07:15:23 -0700


Thanks very much. This is helpful.

Are there any examples of such guides that one could look at?

best,
Paul

On 11 Meitheamh 2004, at 6:13 am, Marguerite Krupp wrote:

Paul Carr asked about "Capabilities and Limitations" guides.
We used to call them "Concepts and Characteristics" guides, becuase we could
never get the word "limitations" beyond Marketing. In general, they fell out
of favor with the dominance of task-oriented documentation, but I think
they've just metamorphosed into white papers, extended product briefs, and
the like.

As to what goes into them, I would suggest a general overview of the product
from a user's standpoint, focusing on what users can do with the product
(essentially features and benefits, but with less of a marketing spin than
you'd find in a product brief), then a very high-level description of how it
works (no nuts-and-bolts), then the specifications expressed in a way
appropriate to your audience. This might be a list or table. In this way,
you are actually stressing the capabilities of the product and describing
its restrictions without actually calling them limitations.


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

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
From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
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: capabilities and limitations
Next by Author: best practices
Previous by Thread: Your TECHWR-L message
Next by Thread: Powerpoint > Extracting figures/images


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

Sponsored Ads


Sponsored Ads