RE: documenting a database

Subject: RE: documenting a database
From: "Dori Green" <dgreen -at- associatedbrands -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 15 May 2007 08:28:58 -0400

I'd start with a data dictionary:

1. details about each field, including where it appears (tables, queries, forms, reports, etc.)

2. alphabetical list of fields (data dictionary)

3. list of tables, queries, forms, reports, etc.



>From that, I'd create

1. user's guide -- what they can do with it as is (lots of screenshots), templates (if any)

2. developer's guide -- what can be tweaked, what they should leave alone



Dori Green
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Follow-Ups:

Previous by Author: RE: Why I need an Index
Next by Author: RE: documenting a database
Previous by Thread: Re: documenting a database
Next by Thread: RE: documenting a database


What this post helpful? Share it with friends and colleagues:


Sponsored Ads