Documentation Standards 1. As soon as possible, the development team, Project Manager, and Doc Manager should collaborate to produce top level project documentation. This will include the following: * Scope Document. This will cover all known issues of scope including a complete feature list, phase breakdown (what features will be included per phase), and initial timeline. * Database Schema. Details of database table structure including descriptions and data types of each field. 2. Periodically, the Doc Manager will download the CVS tarball and incorporate change notes into the module description documents (described below). Developers are encouraged to make detailed change notes (1-2 lines) every time a file is committed to CVS. If the changes to a module are significant or cannot be clearly condensed into a 1-2 line note, a more extensive summary should be emailed to the Doc Manager for inclusion in the module documentation. 3. When a new module is developed, a short (approx. 1 page) description should be submitted to the Doc Manager. This document should include a summary of what the module does and any cross-module dependencies. See the Authentication Module doc for an example. The Doc Manager will review for clarity and (if necessary) request specific revisions. These module descriptions will be the basis for developer documentation as well as the end-user manual. 4. Just prior to each project build, a full documentation review will be performed by the Doc Manager, Project Manager, writers, and interested developers. The result of this review will be to ensure that the documentation accurately mirrors the state of the codebase, and that it fits together as a coherant whole.