incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <>
Subject [Incubator Wiki] Update of "DocumentationPlan" by RobertBurrellDonkin
Date Sun, 30 Jul 2006 10:50:00 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Incubator Wiki" for change notification.

The following page has been changed by RobertBurrellDonkin:

The comment on the change is:
Document management - initial content

New page:
= Documentation Plan =

It takes time to produce adequate documentation. Often it's hard to merge changes so a little
organisation is a good idea. If you are working on substantial changes to a particular document
then sign up on here. Then people can either work on something else or post something to the
general list.

Not sure whether management via wiki will be better than via JIRA (create loads of tasks?)

== Page By Page ==

Feel free to update with new ideas etc

 * [ Guide For Proposals] is reasonably close.
there's editorial work needed proof-reading, adding links and add examples of good practice
from existing applications. there are a few difficult sections needing more content.

 * [ Guide For Participation] is a new-ish
netiquette/getting involve guide. this needs more content and links into existing documentation
but is intended to be a short document.

 * [ Release Management Guide] is
really just an outline. lot of work required. Project templates needed. 

 * is just a landing page. probably not a
good idea to take this one on ATM. Need a guide for mentors and projects which is what this
was probably intended to be. 

 * [ Guide To Entry] is a landing page with basic
outline. lot of work required.

 * [ Guide To Mailing Lists] needs tidying up.
the index page has a missing link to this page. the website content should be replaced with
a link to the website guide. more content on mailing list best practices would be good.

 * [ Process Document] basically
sound but will need updating to link into the new content. References the Jakarta guide for
sub projects. This is not a good idea.  

 * [ Roles And Responsibilities]
too much duplication. Content needs to be consolidated and with more links added.

 * [ Learning Material] the rest of the material in here
needs to find new homes. rules for revoluntionaries is very badly formatted. the apache way
has some good points but reflects older thinking from the membership: moving away from talking
about the apache way and towards using open development as a term. perhaps history would be
a better place some of this content. need a new document somewhere in describing
open development.

* [ PPMC Guide] Proof-read and decide upon a status
and abstract. Merge in material from the wiki. 

* [ Branding Guide] Consensus about trademark
and naming need to be added. Once public relations have web presence, add links.

* [ Guide Index] fix broken links. Update list
so that drafts are included.

== Universal ==

* Add license headers - most of the documents are missing license headers. These need adding.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message