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.
RE: How do you handle knowing "It Could Be Better"?
Subject:RE: How do you handle knowing "It Could Be Better"? From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 9 Oct 2002 12:06:57 -0400
> So look at those incomplete explanations, those sections
bingo.
I don't have a problem with missed or wrong punctuation, muddy phrasing and
lack of proper proofreading. Some of that stuff is subjective anyway.
What I do I have a problem with is inconclusive, incomplete or shallow
explanations. The thing that I dread the most is a month after I'm gone and
a technician runs to my document, relying on it for help with a major issue
and the explanation is not helpful.
yeah, yeah...how much documentation is out there that falls into this
category...that's fine...it isn't MY documentation and to my knowledge,
hasn't been.
My concern is superficiality...covering an issue enough to say it was
covered, but not enough to do anyone any good, knowing that with more
knowledge, it could be.
Oh, well...let's see how it come out as it progresses.
John Posada
Senior Technical Writer
Barnes&Noble.com
jposada -at- book -dot- com
212-414-6656
"Be accurate...the 4am wakeup call you prevent could be your manager's"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
---
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.
