Documentation

A large amount of technical documentation is available. We have found the frequent lack of good technical documentation to be a major obstacle during work with client databases. It is our goal to provide the documentation needed for later developers.

Typically included:

Entity-Relationship Diagrams: Diagramatic representations of data subjects and the relationships defined between them. One of the most frequently used database design tools, but are almost never provided with off-the-shelf proprietary databases.
Data Model Report: A detailed report showing the characteristics of all tables, columns, and relationships defined in the server database. Typically provided in an HTML format allowing speedy movement to appropriate sections of the report.
User Guide: Text document providing a general explanation of the database contents and features. Typically targeted to a standard user rather than a technical user.
Developer Guide: Text document providing a more technical explanation of internal mechanisms employed within the database. Includes high level descriptions of naming conventions, class modules, form characteristics, etc. This should nonetheless prove useful to any developer engaged to work on the database.
Form Module Modification Instructions: Outlines specific steps needed for a developer to modify a record selection form making use of the SelCtl class modules provided with MS-Access implementations of the database.
Form Navigation Diagrams: Flowchart-style diagrams outlining the major user navigation paths supported by the database. These documents can provide a very fast understanding of the major user navigation approach.

Last modified: 15:39:42 23-Jan-2009