I am, for the first time, writing descriptions for my SQL Server tables (from the Description field in the Properties Window), and I started thinking about what to exactly write in such a field.
For examples, some tables are self-explanatory according to their titles...like a table called Albums in a "Music System". What description would you actually write in such a case?
And what 'other' information do you normally include in the description? Do you mention the relationships to the table?
Is there a standard, formal way for writing descriptions for Tables?
I believe a good object naming and design plus eventually a tool that would visualise you database structure (e.g. SQL Doc) is much better that adding a detailed description to each object.
The more you want to cover in the description the more likely it will run out of sync from the real database structure. E.g. if you want to document the relationship, then each time you change it you need to remember to update descriptions as well (on all the objects involved?) It is basically redundant information because it is already recorded in the schema. We do not want redundancy it the database do we?
3 simple statments should do for a table description: one describing what the table holds, one describing the initial state of data in the table (empty or pre-filled), and one describing how data moves in/out of the table.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With