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.
"John Posada" <> wrote ...
>
> Hi, guys...I've been documenting our SQL system and I understand that there
> is something called a "Data Dictionary".
>
> Now, from my research, I think I've figured out most of the information
> elements that belong IN the dictionary (table name, columns name, data
> types, length, PK/FK, allowed values, etc.) , but what I cannot figure out
> is if it has a formal design. I've searched on this on the web and come up
> with several resources. However, they all seem to present data in any format
> they choose.
>
> I'm thinking that a data dictionary is similar to an API document; they're
> kinda standard. Is this accurate? Do I understand what a DD is? Am I so
> stupid that I should be ground up into hot dogs?
Probably. A data dictionary has no formal design I've ever seen. I used to do
them as big tables. The only other column you would want to add is "null?" to
indicate if the column can be null or not. Also, you'll want a copy of the ERD
in the dictionary. They are usually sorted by table in the DB, not as a huge
column mass.
I used to doc data dictionaries all the time. SQL 2000 is easy, it will
actually give you a nice export of the entire database. Just reformat that and
fill in the rest. I think SQL Server 2000 also has a feature that will doc the
database for you. I don't remember. You'd need admin rights to the database to
access that feature, which the DBA might not want to give you.
Andrew Plato
__________________________________
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo. http://search.yahoo.com
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
