RE: Writing tasks for online help. Specific vs. General

Subject: RE: Writing tasks for online help. Specific vs. General
From: Diane Evans <DianeE -at- LOCKSTREAM -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 6 Aug 2001 09:12:17 -0700

>Is it better to write a general category with information included (less
>topics in the project) or better to have many topics with short, specific
>information

I recently wrote a help file with two sections. The first was a
step-by-step method of the average process (Planning a doohickey, building a
doohickey, publishing a doohickey). The second is an alphabetical listing
of every item on a menu or contol bar. The user can follow one section for
a step-by-step tutorial, or search in the other section for a specific
question. (I suppose a good index would have worked, too, but this is the
way they wanted it.)

Diane Evans
Information Developer
Lockstream, Inc.
425-709-6840 x 230

Ask for the moon, and settle for its reflection in the pond in your back
yard.



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

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

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

---
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: GIS Tech Writing
Next by Author: RE: User Manual Sample
Previous by Thread: RE: Writing tasks for online help. Specific vs. General
Next by Thread: RE: Writing tasks for online help. Specific vs. General


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


Sponsored Ads