Re: the benefit of documentation

Subject: Re: the benefit of documentation
From: Keith Hood <klhra -at- yahoo -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 4 Jul 2008 13:37:03 -0700 (PDT)

Julie, your comments reinforce something that I've been trying for years to make clear to employers. A good technical writer is actually a multi-functional entity. For many products, a TW acts as a first-line product tester, a built-in one-person customer focus group. Of all personnel in the company, TWs who do user guides and help systems use the product in a way most like the customers will.

When it comes to discussing raises and department budgets, that is one thing that can be argued about TW work being value added. We both backstop and parallel the efforts of the QA branch, but with a different focus so it increases the likelihood of finding user-level flaws. So it can be argued that we expand and improve the QA process.

--- On Fri, 7/4/08, Julie Stickler <jstickler -at- gmail -dot- com> wrote:

> While writing documentation I've uncovered bugs,
> usabiity problems,
> missing features, misspellings in the UI and configuration
> files, and
> all sorts of other issues that eventually led to a better
> product.


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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

Re: the benefit of documentation: From: Julie Stickler

Previous by Author: RE: Microsoft proficient?
Next by Author: Re: Single subheading allowed?
Previous by Thread: Re: the benefit of documentation
Next by Thread: Update - Job Definition

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

Sponsored Ads