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: SQL2000 Data Dictionary From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 8 May 2003 10:16:22 -0400
I have three sections. Section one is the ERD diagrams, which also contains
the Primary key and column attributes. They are grouped in clusters on the
page; single if a standalone entity, the group if there is a relationship
The next section of the document is a set of tables:
One set of tables for the entity's column attributes, and null is already
included along with the ones I mentioned.
The next set of tables is the listings for Triggers and StoredProcs. This
section includes the actual code for the trigger and SP. This will be a
separate book as it is currently about 2300 11X17 pages...it will be
delivered only electronic, maybe as an online help. Part of the problem is
that I'm creating this documentation for very knowledgeable people who need
this configuration information but don't have access to Prod to get it
As far as rights, I'm working from the QA environment and they are willing
to accept the differences between the two, which is not that much difference
besides name differences (I have a cross-reference chart) and usually, the
QA has some tables aren't replicated to Prod, such as load testing
databases. I'm using ERwin to extract this information...one of the main
reasons is that ERwin has the ability to store a model of the database on a
local drive and periodically, I can run a full compare to check for changes
to help me update the docs.
Andrew, thanks again.
Senior Technical Writer
jposada -at- book -dot- com
"There are those who look at things the way they are, and ask why... I dream
of things that never were, and ask why not?"
-----Robert Francis Kennedy, 1968 presidential campaign
> 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.
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.