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: When it is right to be wrong? From:Clifford Manley <EManley -at- Solutionsplus -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 6 Feb 2002 11:06:28 -0600
You have to keep in mind our industry's dirty little secret; If it's
printed, it's wrong. Or even; If it's published, it's wrong! In the
fast-paced world of software development change is never ending, and the
moment a writer stops researching and removes the draft stamp it's out of
date. You can send updates and release notes till you're blue in the
face...the reality is that so few use them fully that the above still
This fact supports the responders here who suggest you get it as good as its
gonna get and let 'er rip. I try to always keep in mind that we are in
business to sell software profitably, and ask myself if document tweaking
leads to that goal. Usually I find that it does not.
Of course, misleading users doesn't either...
Until we come up with some sort of documentation paradigm that allows
instant update our documents will always be "wrong".
See an STC article entitled "Managing Modular Documentation Using a
Database" by Jim Earley for a more complete illumination of that topic.
Sorry I don't have a citation for that article - I printed it a while back
and forgot where it came from, though I know it was on the STC's home site.
eMail me off-list and I will send it to you.
If anyone has object-oriented or modular documentation experience/desire
please let's talk about it! While I am just starting to learn how to do it,
I believe this to be so important to publishing and technical
communication's future that I am dedicating the rest of my career to making
it happen in software development shops (or to finding a better alternative,
whichever comes first!).
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
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.