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.
>In the reference manual that I have
>inherited, every field is listed and
>described in detail. Given the changeable
>nature of the interface, how would you
>document the fields?
This type of reference manual is a waste of paper and writer resources. I
can't think of one type of audience that would regularly use such a manual.
Even programmers would probably simply figure out the information from the
interface and/or code rather than looking up the field in a manual. There
is rarely any need on a user level for such detailed knowledge. You owe it
to your employer to tally up the cost of the production vs. the actual use
of the manual. If the employer or the clients still insist on the document
just because they are used to it, then you must update it, of course.
The way I would update it would depend a lot on the inherited manual, the
interface itself, and which method would save me time. Cynically, since I
don't see many users reading this type of manual, I would tend to do that
method which made me look good... got done and got the information in and
accurate, if I were forced to update such a manual.
Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002. www.ehelp.com/techwr
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.