Re: Bouncing Reality Checks

Subject: Re: Bouncing Reality Checks
From: Fred Sampson <wfreds -at- cruzio -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 09 Dec 2002 10:57:25 -0800


Are you sure the SME meant "accurate" and not "complete"? Given time constraints and such that we all deal with, sometimes the scope of documentation doesn't cover everything we'd like to--but what we do document had better be accurate. While one can argue that incomplete = inaccurate, I think incomplete doc is less damaging than inaccurate.

When asking for reviews, I sometimes tell a reluctant reviewer, "At least make sure I'm not lying to the user."

-Fred

At 09:18 AM 12/9/2002 -0800, you wrote:

Just wanted to check in with another reality update from the trenches.

I sat in a meeting the other day discussing the documentation of a new system
capability. THE Subject Matter Expert on this particular capability asked, "Do we
want this documentation to be 100% accurate? Or is pretty close good enough for our
needs?" It seems that he was concerned with whether or not he actually needed to
review the documentation, since it wasn't for him. HE knows the system.

Now this is the engineer, not the writer, asking this question. I guess it's not
simply a problem that writers don't care about content. Sometimes writers care more
about content than those for whom they are writing.

=====
Tom Murrell

Fred Sampson
wfreds -at- cruzio -dot- com
http://radio.weblogs.com/0107659/


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today 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.



References:
Bouncing Reality Checks: From: Tom Murrell

Previous by Author: RE: removing an extra space after text that's imported by ref
Next by Author: Re: Small victories
Previous by Thread: Re: Bouncing Reality Checks
Next by Thread: RE: Bouncing Reality Checks


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads