Re: Empiric studies on the impact of documentation

Subject: Re: Empiric studies on the impact of documentation
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: Gene Kim-Eng <techwr -at- genek -dot- com>
Date: Sat, 30 Mar 2019 11:04:07 -0700

On Sat, Mar 30, 2019 at 09:59 Gene Kim-Eng <techwr -at- genek -dot- com> wrote:

> ...Part of that is understanding the role documentation plays in the
> development and support of product, what it can and cannot be
> expected to "fix" if the other parts of the process are neglected, and
> realizing that sometimes the "fix" to a potential "documentation
> problem" is going to be supporting someone else whose part of the
> process is being given short shrift. For example, a failure analysis,
> safety or test engineer.

It just astounds me that this documentation/product disconnect could happen
in aviation, such a highly regulated industry. I can see it happening a lot
in software design where the developerâs response when I commented that the
software didnât work was often, âThe question is not âdoes it work?ââThe
question should be, âIs it useful?ââ

I lost my last job because I told the boss I was unable to document an
end-to-end use case that the customers needed because at the time the
product didnât support one. Had I been told I was supposed to write science
fiction before people were actually expected to use the product in their
working environments, I would have done so, and might still have a job.

One discussion with our lead editor began with her exasperated sigh: âDonât
even get me started about the expectation for documentation to solve
problems in the product.â

Visit TechWhirl for the latest on content technology, content strategy and content development |


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @

Re: Empiric studies on the impact of documentation: From: Gene Kim-Eng

Previous by Author: Re: Easy movie maker for Macs?
Next by Author: Re: Empiric studies on the impact of documentation
Previous by Thread: Re: Empiric studies on the impact of documentation
Next by Thread: Re: Find & Replace in DW

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

Sponsored Ads