RE: Benchmarking Technical Documentation

[Marguerite Krupp <mkrupp -at- cisco -dot- com>]

[responding to Kelly's post]
Now hold on there, folks! Often only the developer/programmer knows what
last-minute technical product changes have occurred. Therefore their review
should be REQUIRED, even if you, the writer, have been "involved from the
ground floor." Engineers do code reviews on each other's stuff. They should
do the same for anything we write. It's part of our development process.

Sure, the writer should know how to use the product, and it's definitely a
writer's responsibility, IMHO, to ensure the technical accuracy of the docs
as far as possible, not just to be a "pretty formatter." But to state that
it's OK, even desirable if the engineer/SME "did not even look at my
document/help" is to put the user, the company, and even yourself at
unnecessary (even foolish) risk.

Marguerite

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Learn about tools and technologies for user assistance developers at
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com


---
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.