We help IT Professionals succeed at work.

Example of robust system design documentation

1,111 Views
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.

ET_VB
Comment
Watch Question

Master of Business Engineering Management
CERTIFIED EXPERT
Commented:
Unlock this solution and get a sample of our free trial.
(No credit card required)
UNLOCK SOLUTION

Author

Commented:
Thanks for the comments. Those tools will provide a great start.  
Forced accept.

Computer101
EE Admin
Unlock the solution to this question.
Thanks for using Experts Exchange.

Please provide your email to receive a sample view!

*This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

OR

Please enter a first name

Please enter a last name

8+ characters (letters, numbers, and a symbol)

By clicking, you agree to the Terms of Use and Privacy Policy.