Project Zero documentation development

Documentation for:

Going forward

When you are editing any of the documentation html files, BEFORE storing them in SVN do the following:

  1. Run the file(s) through an html validation service and be sure they are free of errors: http://validator.w3.org/.
  2. Run the file(s) through the CHKPII tool (which you can get here: http://w3-03.ibm.com/globalization/page/2011) and be sure they pass.

Look over the following information and bookmark it for ongoing reference:

Cleaning up CHKPII errors

Several errors and issues were found when the files were packaged for translation. All decimal/hex symbol strings were replaced when we migrated from the Wiki environment, for example:

"
Somehow, new ones managed to seep into the files. So if you find any, replace them. You can use the Cleaning up html (and CHCKPII) errors page to see a list of how these should resolve, and solutions for other CHKPII errors you might encounter.

Milestone M7

The documentation process has changed. See Milestone M5 below for information on how this change is being developed and posted and see the following pages for clean up work that needs to take place and structural changes:

Coming for the next go-round:

Milestone M5

The documentation process has changed. Information on this change is being developed and posted on the following pages:

Milestone M3

Line items to be included are documented in the M3 Development Web site where links to the items in Bugzilla are provided.

Other items to be completed include:

  • If, and if so how, to provide online help
  • Architectural work on the current Core Developer's Guide

Milestone M2

Milestone M1

Manual tests

Reviews to confirm that the documentation is correct for a given build are summarized as a set of manual tests?.

Sandbox Pages

Sandbox pages are free-form pages for presenting design ideas. Please discuss these designs in the Development forum.
Page Owner: Leesa Payne

r18 - 09 Oct 2008 - 20:31:01 - paynel
Syndicate this site RSS ATOM
Copyright 2007 © IBM Corporation | Privacy | Terms of Use | About this site