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: At what point can I pass the buck? From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 Mar 2009 07:45:42 -0700
I would check to ensure the documentation is correct and is sufficiently clear
that it is not being misread. Once I'm confident that that's the case, then
unless
the anomaly is so obvious that it's staring me in the face, I'd pass the
question on to the SMEs to determine what the problem is. The "why" should
always come from the SMEs.
Gene Kim-Eng
----- Original Message -----
From: "Downing, David" <david -dot- downing -at- Fiserv -dot- com>
But some of the questions I'm getting are on the order of, "The documentation
says it's supposed to work this way, but that contradicts what's happening when
the client tries to do such-and-such. Is the product misbehaving, is the
documentation wrong, or am I misreading the documentation?"
Of course, if the documentation is inaccurate or ambiguous, I need to know that,
but to what extent is it my responsibility to explain why the product is
(possibly) behaving in an anomalous fashion. At what point am I justified in
passing the buck to the SME?
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-