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.
Subject:RE: In search of a term From:"Leslie Johnson (Meridian Partners Ltd.)" <a-leslij -at- microsoft -dot- com> To:"'techwr-l -at- lists -dot- raycomm -dot- com'" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 16 Mar 2000 07:25:12 -0800
What's in the intermediate level? I assume that the Product level contains
conceptual or overview information about the product, and the Module level
contains prodedural or task information. Does this mean that the
intermediate level contains information about how some of the modular
information is grouped (or used) together?
Also, how are these terms being used? Are they being used by the doc team to
refer to specific types of information, or are they being used in the docs
themselves? If these terms are being used in the docs themselves, perhaps it
might be more appropriate to use the actual names of the tasks or groups of
tasks rather than calling the information "Product", "Module Group" (or
whatever) and "Module". I've never seen documentation successfully
generalize the information in this way, without giving the user some hint
about navigating through the docs and tying the doc information to the
Good luck Beth! It's always tough to come up with that "perfect term"
that'll solve all the problems!
From: Scudder, Beth [mailto:beth_scudder -at- retek -dot- com]
Sent: Wednesday, March 15, 2000 8:25 AM
Subject: In search of a term
I'd like to solicit suggestions for a term. I know there's no "set" or
"right" or "proved" one, and I know it's my choice, but I would like more
suggestions, in the hopes that one of them will sound better than what I've
come up with.
We have three levels of information included in our documentation:
Product level (the most general level)
*something* level (the intermediate level)
Module level (the detailed level)
The terms "product" and "module" are set at this point (we have a May 1
release date), and cannot be changed. However, we need a name for the
intermediate level of information. Two ideas thus far have been "Functional
Area" and "Subject Area", but I'm not too thrilled with either of those.
Sponsored by Weisner Associates Inc., Online Information Services
Training & consulting for RoboHELP, Dreamweaver, HTML, and HTML-Based Help.
More info at http://www.weisner.com/train/ or mailto:training -at- weisner -dot- com -dot-
Your web site in 32 languages? Maybe not now, but sooner than you think.
Contact ForeignExchange for the FREE paper, "3 steps to successful
translation management" (http://www.fxtrans.com/3steps.html?tw).
You are currently subscribed to techwr-l as: a-leslij -at- microsoft -dot- com
To unsubscribe send a blank email to leave-techwr-l-29946N -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.