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.
My basic position has always been to document the system as is. I bring things to
the team's attention and to management's attention as to what the final product will
say about the system, or whatever, when we do that and recommend that they clean
things up if they don't want the documentation making the product look bad, even
internally. But the bottom line is I document what it is as it is, not what it
should be or what someone hopes it will become.
That said, I do consult with management and/or the team about documentation issues
such as the one you bring up and try to reach a consensus on what or how we're going
to do it. So far, I've never had trouble getting buy-in for either fixing/cleaning
problems or documenting them. However, they are paying the bills and if they want it
done a certain way, I'll do it. (I'll probably start looking for another job if I
find the situation onerous, and I have.)
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.