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've been thinking...in my current project, I'm trying to decide whether to
produce task-based online help or reference-based online help, as there are
LOTS of reference/display only fields. We're talking screens that have 20
display fields and 1 enterable field. For example, we have a screen to enter
a Cost Invoice. Should I do something like....
To enter a Cost Invoice:
-Select the Cost Invoice link to access the form.
-Verify that the Contract Name listed is correct.
-Enter xxx in the xxx field.
-Verify that the xxx listed is correct.
-Select the [Submit] button to submit the invoice.
However, since we have so many fields on the screen that are display only,
maybe I should do something like this:
COST INVOICE FORM
Most of the fields on this form are display only. Fields requiring data
entry are shown in green.
Field 1 - Display only. This field displays....
Field 2 - Display only. This field displays....
Invoice Amount - Required field. Enter the amount of your invoice.
Field 3 - Display only. This field displays.....
When you have finished entering the required information, select the
[Submit] button to submit the invoice to the system.
Whadd'ya think? I think (hope) the screens are intuitive enough (and they
will have training) that they're not going to look to the help for "how to
do x". I'm presuming they would use the help as a reference to see what an
obscure field title actually means. I generally prefer to provide task-based
help, but another factor is that this is page-level help that will be
launched directly from the appropriate page. (We can't do field-level for
*** 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
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
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.