TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: documenting a database From:John Posada <jposada01 -at- yahoo -dot- com> To:Dori Green <dgreen -at- associatedbrands -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 15 May 2007 06:55:13 -0700 (PDT)
> I'd start with a data dictionary:
I agree
> 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.
I disagree. I mean, I agree, but I disgree on approach. DBAs have
expectations from their Data dictionaries. There are conventions. For
instance, an alpha list of fields means nothing to a DBA without
knowing first, the database and entity (table name) because you could
have multiple table columns with the same name.
Use a program made for creating one..give your DBAs what they expect
and make your life easier. A data dictionary from a large enterprise
could be hundreds of pages long.
> 1. user's guide -- what they can do with it as is (lots of
> screenshots), templates (if any)
Every DBA uses a database and they already know how to use it. Skip
this.
> 2. developer's guide -- what can be tweaked, what they should
> leave alone
Every DBA uses a database and they already know how to use it. The
databse is designed with these controls build in. Skip this.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 & 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 & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-