admin@glassfish.java.net

Re: AS 9.1 P1,P2,P3 Documentation Bugs

From: Paul Davies <Paul-Martin.Davies_at_Sun.COM>
Date: Wed, 04 Apr 2007 10:25:28 -0700

Hi Judy,

> I agree the more review the better, so it is good for engineering to
> review bug fixes when there is time. But when there
> is short of time, I feel we should let developer spend the time on the
> first round of doc review. That will help to eliminate
> the bugs logged by SQE. It is very expensive to log bug, fix bug,
> verify bug.

It seems to me that we are discussing two things simultaneously:

* Review process for changes and additions to doumentation

   I agree that when technical changes or additions are first made to a document,
   those changes or additions should be reviewed by engineering SMEs before
   the modified document is given to SQE for verification. Such a process should
   minimize the number of bugs that SQE logs against the document.

* Review process for fixes to bugs logged against documentation

   By the time a bug is logged against a document, the first review phase
   is already passed, so the "first round of doc review" stage cannot apply. To
   prevent furher bugs against the fix, I am proposing that the fix be reviewed
   privately by the engineering SME and, potentially, the bug submitter before
   the fix is made available (for example, for a bundled doc, by checking in to
   the build). I realize that having individual bug fixes reviewed is time
   consuming, but I do not see any alternative if the accuracy of the fix is to
   be assured.

> Remember in one of the admin iteam
> meeting, we all agreed it is a good idea to have engineering to give the
> first round of manpage review, then SQE can
> do the final review and log bugs during this final review, but later on
> after doc team checked in manpage, there was no
> time left to do this kind two round of review.

It's true that lack of time prevented SQE from reviewing checked in man pages in
time for beta1. However, our recovery plan, as agreed by this team, is to fix
bugs for beta 3 and ensure that any further changes that might arised from
verification of the fix, are made by AS 9.1 RR.

Regards,
-- 
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/