"Bug" reporting for documentation?

Subject: "Bug" reporting for documentation?
From: Bernd Hutschenreuther <bernd -dot- hutschenreuther -at- net-linx -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 14 Jul 2000 11:18:28 +0200

in our documentation team, we are also starting to use StarTeam, but I have
no experience with it until now.
Another thing is, that documentation is included into quality assurance
We have four different levels of bugs, the lowest is "d". Documentation
issues are mostly c and d.
For some clients, we give detailed reports about all changes of contents in
documentation, (exceptions are spelling or grammar errors.)
One reason is, the documentation will be translated to other languages.
There spelling errors usually disappear, but contents must be changed,
without translating the whole text again.

These are also included into (internal and external) test procedures.
The error levels help us to decide priorities.

And it is much better to fix bugs reported by test team than by clients.

The problem to track the changes lies in the complexity. The documentation
reached now a length of almost 2000 pages.
Fortunately, we are working now with specifications, in earlier times, the
documentation was used as a kind of specification.
But: The program was changed, so we had to change the documentation, and
often we had to guess how the program should be working.

Now we are doing only changes for signed of specs, either by clients or by
research and development.

Higher quality of documentation.
Documentation is (almost) ready together with the program.
Free Saturdays and Sundays.

Best regards

Bernd Hutschenreuther / Technical Writer
net-linx Europe GmbH Dresden / mailto:Bernd -dot- Hutschenreuther -at- prepress -dot- de
Kaethe-Kollwitz-Ufer 76 / tel: (+49) 351-31875-732
01309 Dresden, Germany / fax: (+49) 351-31875-550
Home: +49-351-8483427 ;-) mailto:Bernd -dot- Hutschenreuther -at- sz-online -dot- de

Previous by Author: Incredibly frustrating FrameMaker/PDF problem (long)
Next by Author: Re: FrameMaker running headers and footers
Previous by Thread: RE: "Bug" reporting for documentation?
Next by Thread: RE: "Bug" reporting for documentation?

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

Sponsored Ads