db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart" <scotsmat...@gmail.com>
Subject Re: 10.2 documentation reviews
Date Wed, 16 Aug 2006 15:45:06 GMT
As one of the people who is interested in implementing the comments
that are made on the documentation, I would like to see the following
:

1. Tables for each book on the wiki pages that Jean created. The
columns should be: Section name, Page, Comment, Status
where
Section name = the name of section in the book that you are making a
comment on.
Page = the page number (PDF or printed) that your comment refers to.
Comment = Short comments should be entered here using the guidelines
on the main TenTwo Documentation page:
http://wiki.apache.org/db-derby/TenTwoDocReview
Longer comments should not be entered into the table. Instead a Jira
issue should be created with DOCS as the first word in the title, and
the number (link) for the Jira issue entered into the table.
Status = This column is used by people updating the documentation to
indicate when the comment is incorporated into 10.2.

2. The suggestion to divide the books up by chapter/section for the
reviews is a good one.  This will give the docs a more global review
than just re-reviewing the information added in 10.2.  With this
approach it is very likely that someone will run across a section that
should have been updated for 10.2 and was missed. It will also find
sections that need to be improved.

-- 
Laura Stewart

Mime
View raw message