Have you ever tried to manually document a SQL Server database? I have, and it’s no fun. In fact, and I hate to admit it, my documentation was not as thorough as it should have been. And did I keep the documentation updated like I should? I think I’ll skip answering that question.
As DBAs, we know how important it is to document our databases. But in case you are new to DBA work, some of the important reasons include:
Each of the above are reasons why it is important to have good database documentation available. If it is not available, then you, or someone else, may have to spend many hours figuring out how the database is put together before you or they can proceed with the task at hand.
To make our life as DBAs easier, A & G Software developed SQL Scribe Documentation Builder, the very first SQL Server database documentation available on the market. Using it, you can automatically create comprehensive SQL Server database documentation in minutes. Not only does this make creating original documentation easily, it makes maintaining it a snap.
So What Can SQL Scribe Documentation Builder Do for You?
Essentially, SQL Scribe Documentation Builder uses SQL-DMO calls to reverse engineer your database, and then places all of the documentation in a website, in a HTMLHelp file, or both.
If you prefer the HTML website documentation, you can place the documentation on any website for people to access.
The HTMLHelp file, which can be easily accessed from an intranet website, network share, or your local computer; allows you to easily and quickly find the data you need. It even supports wildcard searches.
The program can create documentation of MSDE, SQL Server 7.0, and SQL Server 2000 databases.
If you have a lot of databases you want to document, or if you want to rebuild the documentation of your databases on a scheduled basis, you can by using the software’s batch mode. For example, you can schedule a job to run nightly of a database under development so that everyone has the latest documentation of the database.
How Does SQL Scribe Documentation Builder Work?
SQL Scribe Documentation Builder is easy to use. In fact, you probably will never need to even take a look at the software’s documentation. Here’s a quick look at how it works.
When you first start the program, a six-step wizard begins, as you see below.
Next, you need to specify the server, database, and authentication method you want to use.
Next, you need to specify where you want to store the documentation that is created.
By default, your entire database is documented. If you want, you can exclude some parts of the database from documentation by using this screen.