• ScottPletcher (12/26/2012)


    Sean Lange (12/26/2012)


    SQL_Kills (12/26/2012)


    Hi,

    First of all I hope everyone has had a good Christmas!

    Just wanted to know if anyone documents there table using MS_Description? I'm struggling to think how much detail I should put on there so the end user understands what this table entails. I would also like to say which ssis package populates this table or if this gets populated by other source of etl process.

    Just need an example I can look at and I can then use that best example from now on.

    Thanks

    End users should not be seeing your table definitions. This type of documentation is for technical people (dbas, sql devs, etc). People that can view the table definitions. That being said, I don't find it to be very useful because you have to dig around to even realize the information is there.

    I somewhat disagree. I quite agree that most end-users should not be able to get table documentation, per se, since they should not be aware of tables. Typically, however, a few selected "power users" can use this info.

    I generate documentation into the extended attributes, although I store the original documentation in a database. I can then generate to other formats also (html, xml, etc.).

    Sounds to me like we didn't disagree at all. 🙂 We both said it is for a few "power users".

    I would be curious how you use the extended properties to help generate documentation. I have never really found the extended properties very useful. Do you use them to generate help files / technical documentation?

    _______________________________________________________________

    Need help? Help us help you.

    Read the article at http://www.sqlservercentral.com/articles/Best+Practices/61537/ for best practices on asking questions.

    Need to split a string? Try Jeff Modens splitter http://www.sqlservercentral.com/articles/Tally+Table/72993/.

    Cross Tabs and Pivots, Part 1 – Converting Rows to Columns - http://www.sqlservercentral.com/articles/T-SQL/63681/
    Cross Tabs and Pivots, Part 2 - Dynamic Cross Tabs - http://www.sqlservercentral.com/articles/Crosstab/65048/
    Understanding and Using APPLY (Part 1) - http://www.sqlservercentral.com/articles/APPLY/69953/
    Understanding and Using APPLY (Part 2) - http://www.sqlservercentral.com/articles/APPLY/69954/