Documenting SQL as a Administrator not Developer

  • How/What do you document about a SQL Server (as a whole and on individual instance)?

    Most of the post I have come across reference documentation on the development or design of a database side of SQL Server. I would like to find out what information DBAs take note of for documenting the configuration of SQL Server itself. Sort of the Administration side of things.

    I would believe you want to provide enough documentation to satisfy management in that they know I can give them the pertinent information about a SQL instance when they ask for it. However how deep should you go with this? Them would level of documentation you need depend on the circumstances, maybe for disaster recovery, vendor support, or to be able to provide information for someone replacing you?

    Shawn Melton
    Twitter: @wsmelton
    Blog: wsmelton.github.com
    Github: wsmelton

  • I'd start with this information:

      Server Specs - CPU's, memory, drive configuration, OS, SP level

      SQL Server Specs - licensing model (# of licenses), version, edition (standard, enterprise, etc...), SP level, services installed (SSRS, SSIS, SSAS, Full-text), options enabled/disabled (xp_cmdshell, clr, etc...)

      Logins

      Databases - users, roles

      Jobs - when, why, what

      Schedules

      Alerts

      Operators

    Those are just some things I can think of off the top of my head.

  • Jack has a good list, I also used to log the sp_configure options.

    I'd set up a database for this stuff, make it a standard name (I used dba_admin) and then create some tables to hold this stuff. If you can script the logging, I'd log it every day and include this db in the backups. Can be very handy for DR situations.

  • Thanks for the assistance!

    Shawn Melton
    Twitter: @wsmelton
    Blog: wsmelton.github.com
    Github: wsmelton

  • Might I add:

    Service accounts used for each service, and any non-standard permissions for them.

    Rich Mechaber

  • Jack,

    Do you have a draft copy? I'd love to have a peak at your handiwork on such a doc.

    Zee - General Dynamics, Atlanta GA

    🙂

  • Hi,

    I use these headings, they might give you some ideas:

    Instance Name

    Current Version

    Status

    Additional ?Components

    Databases

    Backup Strategy ?(DB, Log, Server)?

    Maintenance Plans

    Authentication

    Notes

    I usually note the location of the system and user DBs. I'm not responsible for the server machine itself. Status is like 'Production', 'Test', 'Offline'. HTH

  • Have you looked at BIDocumenter Tool to document Sql Server Database

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

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