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: What help? (was RE: Help on Procedure Writing From:Jason Willebeek-LeMair <jlemair -at- cisco -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 5 Dec 2001 11:44:04 -0600
Kevin wrote:
"A special place in hell should be reserved for developer/
writers who copy the button name or the field name into
the "What is?" text for a button or field."
I agree whole-heartedly with Kevin.
So, trolling for opinions, what do y'all think should appear in "What's
This" help?
In our app, we provide:
* Field Name
* Whether it is Optional or Required to complete the panel
* A description of what it does, what other areas of the app it affects, why
you want to use it, etc.
* An expected value (example, alphanumeric value up to 255 characters
including symbols except for the question mark)
* An example
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.