Showing posts with label practice. Show all posts
Showing posts with label practice. Show all posts

Sunday, February 19, 2012

Documentation

I'd like to know what best practice is on documenting a new database that I
created. What type of diagrams and definitions and how specific or high
level should the documentation be?
Thanks
that's hard to answer without knowing the particulars of your database
or application, however, i use the following guideline for documenting
pretty much anything i work on: if someone new were to take over your
role, would they have enough documentation to do the job?
sorry for the unspecific answer.
arthur

Documentation

I'd like to know what best practice is on documenting a new database that I
created. What type of diagrams and definitions and how specific or high
level should the documentation be?
Thanksthat's hard to answer without knowing the particulars of your database
or application, however, i use the following guideline for documenting
pretty much anything i work on: if someone new were to take over your
role, would they have enough documentation to do the job?
sorry for the unspecific answer.
arthur

Documentation

I'd like to know what best practice is on documenting a new database that I
created. What type of diagrams and definitions and how specific or high
level should the documentation be?
Thanksthat's hard to answer without knowing the particulars of your database
or application, however, i use the following guideline for documenting
pretty much anything i work on: if someone new were to take over your
role, would they have enough documentation to do the job?
sorry for the unspecific answer.
arthur

Documentation

I'd like to go through and document the databases I'm responsible for...it's probably a good practice and I'm sure there a several approaches to doing so.

Anybody have comments, recommendations, or possibly a nice word template that links everything up?

Thanks for the input.

AlexIf you don't want to invest into third-party tools some of which may be quite pricy, I'd start with data diagrams available FOR FREE. With this functionality you can create a modularized set of graphical documentation for every database. It may be quite tedious, but is worth while having.