Re: documenting a database

[Ned Bedinger <doc -at- edwordsmith -dot- com>]

> 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 -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.