RE: RE: Benchmarking Technical Documentation

Subject: RE: RE: Benchmarking Technical Documentation
From: Maggie Secara <MSecara -at- NILS -dot- COM>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 24 Jul 2001 09:30:20 -0700


I start each new section with two basic segments/paragraphs/chunks/whatever:
What it's for (which covers what is it and what does it do) and How you use
it. I pretty much cover the golden list in the course of answering those.
Whatever works.

I'm just surprised so many people saw this as a revelation.


Maggie Secara
NILS Publishing Company
(818) 734-3570

> -----Original Message-----
> From: ccallen -at- beckman -dot- com [mailto:ccallen -at- beckman -dot- com]
> Sent: Monday, July 23, 2001 2:37 PM
> To: TECHWR-L
> Subject: RE: Benchmarking Technical Documentation
>
>
> Wade (and several others) seem to believe Andrew's five questions are,
> indeed, golden.
> >I made mine into a power point and put it on my wall
> > Andrew Plato wrote:
> > [snipped]
> > When documenting something, you must answer the five golden
> questions:
<snipped further to make Lyris happy>
> > [end snip]
The first three (and maybe the fifth) are relevant, but can easily be
covered in a few paragraphs in the intro or description
section. How it works is seldom of interest to the user (do I care how my
telephone or VCR works? no). But the most important question isn't even
mentioned--HOW DO I USE IT? That's what user's really, really need to know.

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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Learn about tools and technologies for user assistance developers at
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com


---
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.


Previous by Author: RE: Salary (Was Newbie/Tight Market)
Next by Author: RE: If you could ask your users a question...
Previous by Thread: RE: Benchmarking Technical Documentation
Next by Thread: Re: Benchmarking Technical Documentation


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


Sponsored Ads