Is there a SQL DOC in the House?
|
|
|
Documentation for the Novice DBA Part 1
|
|
|
|
This article presents a basic overview on the various forms of Database Documentation that are practiced by most DBAs
|
|
|
|
Anil Mahadev
|
|
1/20/2009
|
|
|
Introduction
How many times has this happened to us? All our DBA Managers often times come around and ask us for the latest updated schema for the Customer Database that was recently updated during a Maintenance Window that occurred on Jan 5th 2009...
Where to do go now? You forget to create that very Database diagram that your instructor at DBA School told you so much about and you did not do it. Now if you only generate the scripts and issue them to your Manager, he/she would say, where is Table X related to Table Y, I need all the details Now! You could either cry for help or you probably follow some of these steps that helped me become a Productive and Documented Oriented DBA.
Often documentation is not a very favourite topic of one and all in the Industry, only designed for Technical Authors and Business Analysts alike.
Nowadays documentation is becoming a vital part of the DBA profession. Documentation helps improve one’s understanding of the LOB (Line of Business) Applications.
Everyone has been in this kind of situation; here are some of the best practices that one can follow.
1) During the Kick off Meetings, always pay attention to the Architecture that is being related to the application. Document it even though the Project Manager and Business Analysts are doing the same.
2) Go back to your desks and start visualizing on how you should design your database. One of the best tools that has helped me document is either SQL Server Management Studio’s Database Diagram option and another one of my favourite is SQLDoc (Short for SQL Documenter) from Red Gate Software.
3) Maintain a Database Documentation Folder in the Server and make it accessible only for Authorized Management, CTOs, CIOs and Senior Architects / Project DBA Managers
4) Database documentation must be split into two sections,
One; A descriptive yet flexible section that is easy to understand for the General user of the Document, which might include Technical Authors, who would be interested in adding a few comments at a later stage for improvements.
Two; A technical section meant for Top Level, Senior and Execution Level groups for better understanding on how each table is related to each other and which table, when modified could impact the other tables in the database etc.
5) Visual Appeal: Most of us are drawn towards learning and grasping things visually, at least I have managed to do so in my career so far. Make the documentation highly presentable and to the point
6) Backup the Documentation when new Schema Changes Occur: Whenever new schema changes occur within the database, to maintain a replica in the event, certain things need to be rolled back, you could re-use the old documentation and restore your database to a consistent state using the previously scripted objects.
7) Documentation is not just about creating and maintaining database schema information; it also involves documenting steps to resolve a particular problem.
For example: A database yesterday was in Suspect Mode. What did you do in order to bring it back online again?
a) You first checked if the files were moved to another location
b) You discovered that they were moved; now you go and re-attach your database pointing to the new file location
c) You brought the database online again!
8) Attention to Detail: By the time you have implemented steps 1 to 7 , I am positively certain, you would have reached DBA Doc expertise to a certain level.
9) Finally, make it a Habit. You will love it as much as you love jogging early in the morning or hitting the Gym, you get the idea... J
10) This makes you a very good communicator in both written and verbal areas. You will be the next DBA Heroes/Heroines of your Company
In my next article, I shall be covering on how to use various SQL Documentation tools and how easy it is for DBA and Technical Authors alike to get started.
Please do send me your feedback to Anil Mahadev, anil.mahadev2009@live.com “Subject Line: Documentation for the Novice DBA Part 1”