It is not enough just to create great documentation. Readers must be able to find and use it too. Documentation must be made available to readers in a way that makes it easy for them to find it, use it, and offer feedback.

Building Documentation

Online help documentation does not need to be built by the documentation manager. It is automatically built when a new version of Zope is built. However the documentation manager needs to make sure the it is correctly checked into the Zope CVS repository on all the relevant branches.

Documentation not in the online help system should be made available in at least HTML and PDF formats on Zope.org. Most projects will use Python scripts that build these formats from structured text.

All documentation should include information about what Zope version it covers, a change log, credits, and copyright information.

Distributing Documentation

All online help documentation is distributed with Zope. All other official documentation is available at the Zope.org documentation area.

Managers may use python scripts to upload newly built documentation to Zope.org.

Accepting Feedback

All documentation in HTML format will include a feedback form and project URL, others will include an email link and a project URL. The feedback form will give the user access to the project's tracker where they can submit comments, bug reports, patches, and suggestions. They will be able to query existing issues. The email link will submit new tracker issues. The project URL will allow a reader to get to the project status page and find out all about the project.