Documentation and Bug Reports

Subject: Documentation and Bug Reports
From: "John Posada" <JPosada -at- isogon -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 4 Feb 2004 10:47:50 -0500

I recently made a suggestion here and some people in the meeting looked
at my like I had two heads.

The meeting was kickoff between documentation and product management on
an upcoming release of a product. Around here, documentation has a
separate meeting with product management to get a handle on how
extensive they expect the documentation part to be and to address any
questions we may have at the beginning.

Anyway, during the meeting, my manager asked the PM, that since we were
visiting the document for the new version, was there anything else we
could address at the same time.

As part of this, I asked what does the TechSupport/CustomerSupport
logging system show as problems that if the documentation had addressed
the situation in the first place, the call might not have happened in
the first place.

It seemed that the question was comparable to lightning out of a clear
blue sky.

Within 2 days, the logging application was installed on my machine and
I'm able to analyze the reports for issues that could have been
addressed in the docs.

So, my question...anyone else doing this as a routine part of
documentation updating, review, or development?

John Posada
Senior Technical Writer
Isogon Corporation
http://www.isogon.com




Follow-Ups:

Previous by Author: RE: Financial Market Trademarks
Next by Author: RE: Style question: "war dial" vs. "wardial" vs. "war-dial"
Previous by Thread: Re: How to Resize GIFs
Next by Thread: Re: Documentation and Bug Reports


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


Sponsored Ads