Please start any new threads on our new site at https://forums.sqlteam.com. We've got lots of great SQL Server experts to answer whatever question you can come up with.

 All Forums
 General SQL Server Forums
 New to SQL Server Programming
 Documenting my database

Author  Topic 

ron2112
Starting Member

44 Posts

Posted - 2006-11-07 : 13:00:27
Hi folks,

I'm so sure this is a clueless newbie question, I'm embarrassed to be asking it. The short version of my question is, "What's the best path to generating printed documentation of my SQL 2005 database?" The long version follows...

I've just completed the first draft of my new SQL database design (using Management Studio). We were previously storing our data in seven (yes, seven) separate Access databases, now I have everything set up quite nicely in one SQL db, all nice and relational and with proper field sizes and naming conventions, etc. It's all beautiful, but now I need to document it.

Why wasn't it documented first and then built? Let's just say I inherited this task in mid-stream with a looming deadline. Yes, I would have liked to follow a different workflow, but it is what it is and I am where I am.

So I can go through every table and type up everything in Word, but I'm hoping there's some feature in Management Studio that will give me a head start. I read the Help file under "documenting databases," and it says you can output the metadata as and XMLA script. Sadly, it doesn't actually tell you how to do this, which is rather unhelpful.

I'd like to end up with a document that list all my tables, with field definitions, indexes, keys, and triggers. Is there an easier way to get there than going table-to-table and typing it all out?

Thanks,
Ron Moses
ConEst Software Systems

Kristen
Test

22859 Posts

Posted - 2006-11-07 : 13:23:35
This maybe?

www.elsasoft.org

Kristen
Go to Top of Page

Lumbago
Norsk Yak Master

3271 Posts

Posted - 2006-11-08 : 08:44:35
...or maybe this:

http://www.red-gate.com/messageboard/viewtopic.php?t=3592

It's in beta but I think it should be working ok...

--
Lumbago
"Real programmers don't document, if it was hard to write it should be hard to understand"
Go to Top of Page

SwePeso
Patron Saint of Lost Yaks

30421 Posts

Posted - 2006-11-08 : 08:53:40
Innovasys has an excellent documenter too, DocumentX! 5.


Peter Larsson
Helsingborg, Sweden
Go to Top of Page

Page47
Master Smack Fu Yak Hacker

2878 Posts

Posted - 2006-11-09 : 10:07:32
I'm doing the same type of thing right now. The method I've selected is entering metadata into extended properties and then using a tool (like ElsaSoft) to generated the documentation based on that metadata. I think it is working well for my needs now.

Jay White
Go to Top of Page
   

- Advertisement -