db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart" <scotsmat...@gmail.com>
Subject Discussion: Feedback needed on the Documentation Review process
Date Tue, 10 Oct 2006 16:38:41 GMT
For the 10.2 Documentation Review process, a wiki was used to log
comments and track the status of those comments.
http://wiki.apache.org/db-derby/TenTwoDocReview

The purpose of the review is to take a comprehensive look at the
documentation.  Because most documentation updates are made for an
isolated bug or feature, the new content isn't always looked at from a
broader, library perspective. The end of cycle documentation review
enables the community to take a look at the documentation as a whole.

As someone who implemented a large number of the comments, I am
interested in hearing feedback on the process:

What worked well and what needs to be improved in the documentation
review process?

Was the wiki a good way to conduct the reviews?

Did you understand how to log your comments?

There were only a few people that participated in the review.  What
prevented more people from participating?

Is the end of cycle the best time to perform the comprehensive review?
 Should the comprehensive review be performed at the beginning of a
feature cycle?  In the middle of a feature cycle?

Please provide your feedback so that the documentation review process
can be improved.

Thanks!
-- 
Laura Stewart

Mime
View raw message