views:

286

answers:

4

What tool(s) do you use to generate documentation for a database (preferably into a .chm help file)?

+1  A: 
Prakash
+3  A: 

If you are on SQL Server 2000/2005 you can use DBdoc

(SQL 2005 requires a patch that is listed in the comments below the article)

If you have money to spend, you can also use RedGate SQL doc (1.3 is the latest version). It offers (from the homepage):

  • Fast, simple database documentation
  • Document one or multiple databases, down to object level
  • Write, edit, and export documentation in easy-to-read HTML files or .chm files for team distribution
  • Includes all cross-database dependencies
Espo
A: 

We use a wiki so that all developers can/should update it and it is a team effort. A tool that is makes it hard to share, and requires a central "document" will be hard to maintain.

What really do you need? As long as you have a table with the DB schema, document the possible values of each column and their meaning (i.e 1="on hold", 2="Canceled") and then put a image of the main DB tables connected with the foreign keys (export from SQL Server 2005) you are good to go.

csmba
A: 

We use Redgate SQL Doc and we're very happy with the results. We've also had reasonably good results from Document! X from Innovasys (but we mainly use this for documenting COM interfaces).

JV