TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Writing tasks for online help. Specific vs. General
Subject:RE: Writing tasks for online help. Specific vs. General From:"Kathy Mizell" <KathyMizell -at- mfpoer -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 6 Aug 2001 11:12:24 -0500
I would rather see a general category "Editing student information" to
include all detail topics. I would then list the detail topics in an
index to refer the user to the correct general section.
Kathy Mizell
kathymizell -at- mfpoer -dot- com
-----Original Message-----
From: D.R. Smith [mailto:daleindex -at- hotmail -dot- com]
Sent: Monday, August 06, 2001 11:08 AM
To: TECHWR-L
Subject: Writing tasks for online help. Specific vs. General
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.
For example, if I am writing help for teacher software, do I want a
category
titled "Editing student information" that includes changing address,
phone
number, family info, etc. Or do I want many topics that are specific?
For
example, "Change students address," and "Change student's phone number"
as
topics. 15- 20 short topics versus one or two longer ones.
*** 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.