Has anyone ever Documented a Database before?

[klr397]

I need to document an access database but am unsure as to what i should be putting in my final copy. Has anyone ever done this and have any tips?

 

[ScottGem]

Can you explain what you mean by document? Access includes a documenter wizard that will give you a printout of all the fields/tables and much more.

 

[klr397]

yah the documentor is sort of useless what my boss wants is a booklet he could hand to a new employee that would allow them to understand the database better before actually using it.

so at this point i have lists of all the tables and thier fields
list of all forms list of all queries etc etc.

but i was hoping to beef it up a bit.

 

[ColinEssex]

yah the documentor is sort of useless what my boss wants is a booklet he could hand to a new employee that would allow them to understand the database better before actually using it.

There's no point in giving users lists of tables / fields and queries. They shouldn't be able to access that part anyway. Users don't give a toss how it works as long as its quick, simple and easily understood etc.

What (I think) you need is a "Users Guide" on how to use it. When I did this, I just did screenprints of the forms and "talked" the user through each screen. e.g "Fill in as many demographic fields as you can - then press the "whatever" button - this is the screen you should see. . . . . . " screenprint here

etc etc

Col

 

[klr397]

well thats a good idea but i still think my boss wants the lists he wants to know how evreything sort of relates to evreything else. is thier a shortcut to find out what reports use what queries and stuff like that?

 

[Ron_dK]

As stated earlier , you might use the documenter : tools > analyze > documenter. This is a lengthy process, but if you click all selections, it will include the relationships.

Please have a look at these links, they may give you some hints on what to document and what not.


http://www.access-programmers.co.uk/forums/showthread.php?t=49242&highlight=database+user+manual

http://www.access-programmers.co.uk/forums/showthread.php?t=40639&highlight=user+manual


Hth

 

[ScottGem]

As Colin suggests what you are after is a Users Manual. But your boss also wants a schematic as well. So you use the Documenter for the latter. For the users manual, find a screen capture utility and use screen shots to detail how to use the app.

I've attached a sample of one of the User guides I've done for one of my apps.

 

[klr397]

thanks all

 

[ScottGem]

glad to assist