Introduction
When it comes to documenting the database one can never seem to find a volunteer around. The truth is, it’s a frustrating and tedious job, and if you haven’t updated the documentation every time you’ve made a change to the database structure, you will soon find that the task has spun out of control.
I personally have always dreaded being the one picked to maintain database documentation, but that was before I discovered that you could use a tool Like ApexSQL Doc to create really comprehensive database documentation, and score some serious brownie points with your boss.
Objective
In this article I would like to show you how to use ApexSQL Doc to create documentation for your SQL Server on the fly, while highlighting some of the new features of ApexSQL Doc 2008.
Some of the new features include:
- Better project management
- The ability to document multiple databases on multiple servers
- Add extended properties with the new Custom Descriptions Editor
- Document SQL Server Integration Packages
At the end of this article you should be able to use ApexSQL Doc 2008 to create HTML or compiled documentation similar to this:
Getting Started
In order to get started with ApexSQL Doc you need to download it from the ApexSQL website which you can access by clicking here. ApexSQL allows you to test any of their products, using a fully functional version for 30 days.
System Requirements
Software prerequisites :
Microsoft ActiveX Data Access Objetcs Library (ADO) (MDAC) 2.8 or greater
Microsoft SQL Server Vwersion 7.0 or later
Microsoft .NET Framework 2.0 or later is required for all products
Compatible Operating Systems:
Windows NT 4.0 SP3+
Windows 2000
Windows XP
Windows 2003
Windows Vista
Compatible with 64 bit OS versions
Processor:
Personal Computer with an Intel Pentium 600 MHz or faster processor or equivalent
RAM:
256 MB RAM (512 MB suggested)
Hard Disk Drive Space:
30 MB Free Disk Space
Once you have established that you comply with the minimum requirements, and you have downloaded the apexsqldoc.exe installation file, you can move on to the installation.
Installation
ApexSQL Doc uses a wizard approach for installation, so hardly any effort is required. Just follow the on screen instructions and click install on the last step.
