Actor
Manager
Goal
The manager wants to make sure on a regular basis that their documentation project is on track and up to date with Zope developments.
Description
If all is going well an audit will not turn up any problems. However, sometimes authors, editors, or developers may drop the ball. An audit gives the manager an opportunity to verify that documentation is accurate and up to date.
In general audits should be performed when a new version of Zope comes out. When the documentation passes the audit, the manager will mark it as covering the version of Zope that was released. This way audits need not hold up a Zope release, but readers will always be able to tell if an audit is needed.
Audits will normally consist of these steps:
- Manger reviews Zope change log and deduces which changes should be reflected in docs.
- Manager reads documentation looking for obvious problems (like formatting errors) and specifically checks areas of the documentation that cover changed Zope features.
- Problems areas (such as outdated material, or missing descriptions of new features) are assigned to authors for revision.
- After the problems are resolved the manager marks the documentation as covering the newly released version of Zope and publishes the documentation.