Seeking model for database documentation

Latest post 05-09-2004 2:46 PM by mbstein. 3 replies.

Seeking model for database documentation

03-19-2004 1:21 PM

My organization needs to write a simple manual for endusers and administrators that documents the forms and fields in the database - not a technical piece so much as a practical explanation and description - the manual will be compiled by non-techies - I am looking for a model or template to use. Any suggestions?

RE: Seeking model for database documentation

04-29-2004 8:08 AM

Just in case you don't find a model or template, The way I have approached this is to devide it into forms, queries, and reports.

You can begin by describing each form. Try to sequence them in order of use. For example, I start with the switchboard and proceed from there.

Queries and reports need only a breif explanation as to their function.

Hope that helps

Alice

RE: Seeking model for database documentation

05-08-2004 7:54 PM

I use a program called HyperSnap (low cost, powerful, and effective) for capturing, marking up and commenting the application's screens.

Add some explanatory text; use the Table of Contents, Table of Figures, and Index feature of MS Word and you have pretty good documentation.

A. Simon Mielniczuk, Strategy and Systems Consulting
ITISCooperative
Toronto

RE: Seeking model for database documentation

05-09-2004 2:46 PM

One thing we've learned over the years is to think about 2 kinds of documentation. One is technical documentation that describes the database structure, and the application's forms and menus. It's hard to keep this current as your system is enhanced, and the people who most need it have other ways of getting this information, but you will want to have something of this sort none-the-less.

The other, and I believe more important material,is procedural documentation that tells the user how to perform specifc operations, like How to Cancel a Membership or How to Register Someone for Seminar. These docs are a combination of wisdom about the application such as
"Open the Membership Form and click the Cancel Button in the Toolbar" and organizational procedures the software does not enforce like "For child care classes, we always enter a Monday as the Cancel Date" This stuff can be very tedious to prepare, but if you do not have it, as your staff changes your software knowledge dwindles.
michael