Re: How is documentation distributed with your application?

Subject: Re: How is documentation distributed with your application?
From: "Susan W Gallagher" <susanwg -at- gmail -dot- com>
To: "TECHWR-L Administrator" <admin -at- techwr-l -dot- com>
Date: Thu, 6 Dec 2007 11:45:06 -0800

Most of the time, if there's a lag between product deliver and docs
delivery, the root cause is the reticence of the devs to release information
before it's cast in cement. <g> Standard arguments include "I can't tell you
what it does because I don't know until I finish coding" and "but if I tell
you now, you'll only have to change it later." Those arguments are very
difficult to counter, but it can be done if you're careful about building
relationships with the devs and don't whine too loudly when things do change
at the end of the cycle.

Generally speaking, you can garner support from upper management if you
explain your reasoning -- better service to customers, better testing of
docs from QA, ... It's usually easier to get a change implemented when the
mandate comes from the top. That said, be prepared for push-back from both
the devs and QA, who will tell you they don't have time or bandwidth to test
the documentation as well as the product.

Good luck from a veteran of the delivery schedule wars. <g>
-Sue Gallagher

> My company like to distribute the documentation after the code and
> testing has been completed. I have been striving to change this
> mentality and get the documentation released with the application.
> However, there is a great deal of resistance to this. The application is
> released to manufacturing (RTM) and before it goes out to customers, the
> documentation is completed. However, there is always a "catch up"
> situation going on and the documentation is proof-read but not always
> thoroughly tested.

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.

FWD: How is documentation distributed with your application?: From: TECHWR-L Administrator

Previous by Author: RE: musicians among us
Next by Author: Re: musicians among us
Previous by Thread: RE: How is documentation distributed with your application?
Next by Thread: RE: How is documentation distributed with your application?

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

Sponsored Ads