Example of robust system design documentation

Posted on 2007-10-09
Last Modified: 2008-01-09
Hello -

This is my first time using EE.  This question may be outside of the normal realm of EE content but here goes....

I am developing a turnkey DB appliance box for a client to include a detailed documentation set to include -

-OS Config
-DB Config
-HW Config
-SOPs on basic admin practices, etc.

I am not looking for help with the config, rather for a detailed template or example to give me a start with the task of documentation.  I know this subject matter very well and can develop an outline and document on my own but I wanted to ask first if there is a boilerplate that is commonly used.

Any advice is much appreciated.

Question by:ET_VB
    LVL 4

    Accepted Solution

    OS Config: eg: use srvinfo.exe (from MS Resource Kits) to get an overview, paste this output into a txt file or into your documentation.
    HW config: depending on the manufacturer, e.g. if the server is HP ProLiant.... you can use the HP Survey tool to generate an output with the detailed HW configuration

    DB config: depending on you DB (SQL or Oracle.....)
    Create report from you database managing tool(s)

    This will generate a quite big report file.

    All depending on your requirements....

    SOPs: are different in every company, so try to get some other SOPs in your company and use one of them (the best fitting from your point of view) as a template

    Document your tasks done, then you are quite fine anyway, you can not be blamed for things that your predecessor did (or did not!)


    rgds - Frido

    Author Comment

    Thanks for the comments. Those tools will provide a great start.  
    LVL 1

    Expert Comment

    Forced accept.

    EE Admin

    Featured Post

    How your wiki can always stay up-to-date

    Quip doubles as a “living” wiki and a project management tool that evolves with your organization. As you finish projects in Quip, the work remains, easily accessible to all team members, new and old.
    - Increase transparency
    - Onboard new hires faster
    - Access from mobile/offline

    Join & Write a Comment

    INTRODUCTION The purpose of this document is to demonstrate the Installation and configuration, of the HP EVA 4400 SAN Storage. The name , IP and the WWN ID’s used here are not the real ones. ABOUT THE STORAGE For most of you reading this, you …
    From implementing a password expiration date, to datatype conversions and file export options, these are some useful settings I've found in Jasper Server.
    This video shows syntax for various backup options while discussing how the different basic backup types work.  It explains how to take full backups, incremental level 0 backups, incremental level 1 backups in both differential and cumulative mode a…
    Via a live example, show how to restore a database from backup after a simulated disk failure using RMAN.

    745 members asked questions and received personalized solutions in the past 7 days.

    Join the community of 500,000 technology professionals and ask your questions.

    Join & Ask a Question

    Need Help in Real-Time?

    Connect with top rated Experts

    17 Experts available now in Live!

    Get 1:1 Help Now