Database Documentation Using Red Gate's SQLDoc

SQLServerCentral is supported by Red Gate Software Ltd.

Popular Topics

Home

Members

Calendar

Who's On

Home » Article Discussions » Article Discussions by Author » Discuss Content Posted by David Poole » Database Documentation Using Red Gate's...

Database Documentation Using Red Gate's SQLDoc

Rate Topic

Display Mode

Topic Options

Author

Message

David.Poole

Posted Friday, August 07, 2009 3:22 AM

SSCrazy

Group: General Forum Members
Last Login: 2 days ago @ 9:35 AM
Points: 2,749, Visits: 1,407

Comments posted to this topic are about the item Database Documentation Using Red Gate's SQLDoc

LinkedIn Profile

Post #766776

pmiller

Posted Monday, August 10, 2009 7:38 AM

SSC Rookie

Group: General Forum Members
Last Login: Tuesday, February 16, 2010 6:50 AM
Points: 36, Visits: 61

I'm interested in this type of Documentation. I can see where this data will be very valuable but I'm a little scared at what appears to be a very complex process in entering the data.

Post #767857

David.Poole

Posted Monday, August 10, 2009 8:58 AM

SSCrazy

Group: General Forum Members
Last Login: 2 days ago @ 9:35 AM
Points: 2,749, Visits: 1,407

It isn't as complex as it looks. The complexity is in having to rename directories as a result of the timestamp facility but Red-Gate have that down as a thing to be fixed.

The main thing is to start attaching MS_Description properties to your objects. I am probably committing an unmentionable sin by mentioning that there are other database documentation tools out there and they all use the MS_Description property.

Once the MS_Description properties are set they are there for all time and are backed up with the database so you don't have to worry about losing them.

LinkedIn Profile

Post #767931

pmiller

Posted Tuesday, August 11, 2009 6:11 AM

SSC Rookie

Group: General Forum Members
Last Login: Tuesday, February 16, 2010 6:50 AM
Points: 36, Visits: 61

Interesting.
If I load the software on my PC can I direct where the new diectories should be created? I thinking of putting the output on a shared network disk as word documents.?

The package also allows you to edit the descriptions or comments which is the data stored as MS_Description. If I make a change or add new information does the edit feature update the database or do these changes only get reflected in the word document report the one time. If I rerun the report a second time are the changes gone?

I'm trying to determine which would be the better method of updating the MS_Description information.

Post #768517

DavidSimpson

Posted Monday, August 17, 2009 9:14 AM

SSC Eights!

Group: General Forum Members
Last Login: Yesterday @ 9:09 AM
Points: 890, Visits: 932

The idea of automatically documenting a database is a fantastic idea, especially when you store information in the extended properties. Unfortunately SQL Doc is not very flexible and the last time I checked with Red Gate, they had no documented plans for enhancing this tool.

-David

Post #771995

« Prev Topic | Next Topic »

Permissions