Re: the benefit of documentation

Subject: Re: the benefit of documentation
From: "Julie Stickler" <jstickler -at- gmail -dot- com>
To: "Milan Davidovic" <milan -dot- lists -at- gmail -dot- com>
Date: Fri, 4 Jul 2008 13:45:15 -0400

On Thu, Jul 3, 2008 at 9:49 PM, Milan Davidovic <milan -dot- lists -at- gmail -dot- com> wrote:
> "the benefit of documentation rests not only in the document, but in
> the process of creating the documentation. The discovery. The
> discussion. The communication."

Here here!

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.

We've just had a switch in product management, and I've taken the
opportunity to start writing some product specifications while the new
guy is still learning his way around the product. (Planning, not
just for technical writers anymore.) Telling the developers in India
to "just do x" isn't quite producing the quality results that we'd
like. And in the process of sitting side by side with the new product
manager and writing the specs together we've both discovered other
things that we'd like to change or improve.

Yes, it's all about the discovery. The discussion. The communication.

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.


the benefit of documentation: From: Milan Davidovic

Previous by Author: RE: Coworker who won't take no for an answer
Next by Author: Re: Indices and not-indices
Previous by Thread: the benefit of documentation
Next by Thread: Re: the benefit of documentation

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

Sponsored Ads