How to write a database documentation

  • Hi Ellis,

    Thank you very much for your quick reply.

    Regards,

    Oana.

  • Hi guys,

    My last task at work is to write database documentation for a medium size database.

    Can anyone please help me with some links or some tips so i know how to start this? :rolleyes:

    Kind regards,

    Oana Schuster.

  • Check out the SQL Server 2000 Operations Guide. It details the type of information that you should be documenting, basic stuff, but it is important. Store it in a "run book"

    This is the link

    http://www.microsoft.com/technet/prodtechnol/sql/2000/maintain/sqlops0.mspx

    This is a basic list not comprehenive

    Backup locations

    Recovery procedures

    DB file locations

    Server and DB collations

    Logins and Security

    Change log

    Contact Details for key personnel and suppliers

    Maintenance Jobs and their Schedule

    Gethyn Elliswww.gethynellis.com

  • I wrote an app called SqlSpec that does this. It supports 11 different DBMS platforms, including SQL Server. See the link in my sig below for details.

    ---------------------------------------
    elsasoft.org

  • Hi all,

    Your Tool is very atractive, but not document Jobs, or i´m wrong?

    wait,

  • salvadorscardua (3/28/2008)


    Hi all,

    Your Tool is very atractive, but not document Jobs, or i´m wrong?

    wait,

    SqlSpec does document jobs, but not by default. To do it, you need to check the "document jobs" checkbox in the GUI, or pass /u 1 on the cmd line.

    also, if you use the current beta, it will show you the DDL for each job also.

    You can get the beta here: http://www.elsasoft.org/sqlspec_beta.zip

    ---------------------------------------
    elsasoft.org

  • Thanks for more information about SQLSpec,

    About document Jobs routine, only two softwares do it: ApexSQL Doc and SQL Documentation Tools.

    The incredible Red Gate tool, SQL Doc 1.2.0 DON´T document Jobs too.

    : (

  • maybe you misunderstood me. SqlSpec DOES document jobs. You just need to specify that you want it to document jobs.

    ---------------------------------------
    elsasoft.org

  • Three Softwares in my research document Jobs, and your app is one!

    Sorry for not include your app!

    : )

Viewing 9 posts - 1 through 8 (of 8 total)

You must be logged in to reply to this topic. Login to reply