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.
Jane Carnall notes that a developer has finished some documentation that
seems to have many errors and problems, but everyone else does not want to
delay the document or take the time to fix it.
I agree with other posts that Jane shouldn't spend much time worrying about
this document or trying to fix it. But she could take 15 minutes or so to do
a few things to gently point out that this document could be better.
For example, she could return it with a brief note to the developer (and/or
other relevant parties) saying something like, "Glad to see you were able to
work on this document without me. If you can wait until Monday, I have some
ideas as to how I can make it even more clear to our customers. In case this
can't wait, I noted a few of my ideas and questions in the margins." Then
note a *few* suggestions and/or questions in the margins.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See www.forehelp.com for more information and free evaluation downloads
---
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.