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.
I think that if your users are somewhat novice users, the explanation of
which fields are
enabled or disabled is worthwhile. I would definitely use the format of your
It is clearer and gives more information, which is the purpose of informing
the users that
some fields are enabled and some are not.
Just my $ .02
Kathi Jan Knill
Sr. Technical Writer
Kathi -dot- Knill -at- Template -dot- com
The best things in life are yours,
if you can appreciate yourself. ~ Dale Carnegie ~
From: bounce-techwr-l-10443 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-10443 -at- lists -dot- raycomm -dot- com]On Behalf Of Christina
Sent: Monday, December 13, 1999 12:13 PM
Subject: Documenting enabled/disabled items
After procedure steps, do you document which fields are enabled and which
are disabled? What are the advantages and disadvantages of doing so, or not?
My question pertains particularly to software that is not consistent in
appearance or behavior. In my company's software, fields with a white
background are not always editable, and fields with a gray background are
not always read-only. The current user documentation indicates when fields
become disabled or enabled. Here's an example.
2 Click the Add button.
The non-editable fields are disabled.
The editable fields are enabled.
Whether or not you would _word_ things this way, do you think such a
statement helps users? (Our users are familiar with Windows but are not
computer whizzes.) Would this example be more helpful if the specific field
names were listed? Then, the example might read this way.
2 Click the Add button.
The Host, Switch, and Equipment boxes are disabled.
The Calling Feature box is enabled.
If this kind of information is helpful to users, it's worth the maintenance
effort for us writers to keep up with what fields are enabled when. But if
this is just a case of stating the obvious, maybe it's not worth our effort.
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-
Sponsored by ForeignExchange (http://www.fxtrans.com/tw.htm)
Rely on ForeignExchange for responsive and professional
software localization and technical translation services.
You are currently subscribed to techwr-l as: Kathi -dot- Knill -at- TEMPLATE -dot- COM
To unsubscribe send a blank email to leave-techwr-l-10443O -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.