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
manuals
> and I'm wondering what you all think is the best approach for a
useable
> 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
intended.

:-)

Richard



Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------






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

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.
http://www.doctohelp.com/SuperPages/Webcasts/

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
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


Sponsored Ads
http://www.techwr-l.com/archives/0907/techwhirl-0907-00075.html
www.techwr-l.com
crawl=CC-MAIN-2018-34
21274
application/http; msgtype=response
sha1:YDRPOUBI4OPUMP33IH6OZKU27ZQH2BER
<urn:uuid:813840b4-6ee9-4438-a911-a05229b14d29>
2018-08-15T22:18:59Z
184.106.92.169
text/html
sha1:YKPVJSWTE3FRKHZFF5W6FPDPZKCE6TMC
<urn:uuid:944dc01f-6176-4779-a306-81372bd6082e>
http://www.techwr-l.com/archives/0907/techwhirl-0907-00075.html
response
<urn:uuid:5293637e-c769-4359-acad-c032c0f2b0d2>
isPartOf: CC-MAIN-2018-34
publisher: Common Crawl
description: Wide crawl of the web for August 2018
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-146-107-43.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 0.11-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/