RE: User Manuals

Subject: RE: User Manuals
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "LML" <lleduc -at- designnettech -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 2 Jul 2009 10:20:46 -0600

LML wrote:

> I've been researching around and looking at different types of user
> and I'm wondering what you all think is the best approach for a
> manual. <snip>

In the absence of any information at all about the context -- what kind
of product, what kind of tasks, what kind of users, ... -- you're just
going to get the kind of broad generalities covered in the first week of
your local community college tech writing course or in chapter 1 of Tech
Writing for Dummies.

So here's the first such broad generality: Consider the kind of product,
kind of tasks, and kind of users for which the documentation is



Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom


Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:


User Manuals: From: LML

Previous by Author: RE: Edit PDF in Acrobat Pro?
Next by Author: RE: job-hunt weirdness
Previous by Thread: Re: User Manuals
Next by Thread: Re: User Manuals

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

Sponsored Ads