documenting a database

[Ned Bedinger]

> I've worked on procedures, guides, manuals, etc.. now I will be documenting
> a database and I have to admit I haven't the foggiest idea how to get
> started. Any advice out there for me?
>   


 From what I've seen, getting the descriptions of the data is the hard 
part for a tech writer. You can assume the descriptions already exist 
somewhere. But unless they're written by someone like the person who 
designed the database, and unless the design was done within a rigorous 
methodology that involved formal documentation and change management, 
then you're probably going to be looking to the DBAs for cooperation. A 
tech writer who could interview the DBAs and come up with a data 
dictionary would be considerably more than a tech writer, per se.

But anyway, good luck. Data is fun if you can make the investment to 
learn how it works.

Ned Bedinger
doc at edwordsmith.com