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.
If you were creating page-level help for screens that had mostly display
only fields with a few fields that required data entry, would you split the
documentation into "Data Entry Fields" and "Display Fields" or would you
just document each field as it flowed on the screen with the explanation
describing whether it was display only or data entry?
For example, on one screen we have something like this in a table:
Contract Amount - (Display Only)
Funds Sent - (Display Only)
New Request - (Data Entry)
Balance - (Display Only)
Would you separate the "Data Entry" from the "Display Only" or just document
each field in the order it appeared?
Also, I'm trying to think of a heading name for the time period in which
users are allowed to submit data. "Time Period for Submissions"? (yuck!)
Please copy me directly as I'm on digest mode.
Thx for any ideas!
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 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.