System Documentation

[wiegertjd]

Hi,
I'm working on a system documentation project and am in desperate need of a little help. The documentation is supposed to consist of network diagrams, various other diagrams, and then there are going to be sections detailing such things as back-up procedures, configurations, inv lists, etc. I'm trying to find some sort of a template or other resource to get me started on this project.
Anyone have any ideas?

Thanks

Chad

 

[johnherman]

Documentation should be based on the architecture, design, and specification documents you developed before beginning th actually build the project. You did develop documents such as these, didn't you?

The functional specification or user requirements is probably the best template.

-------------------------
The reasonable man adapts himself to the world. The unreasonable one persists in trying to adapt the world to himself. Therefore all progress depends on the unreasonable man. - George Bernard Shaw

 

[thedaver]

You can, of course, seek advise from the overseeing bodies that "govern" such areas of interest as well in an attempt to gather templates.

IEEE, OWASP, various RFCs, etc. You can also try slipstreaming a bit by looking at presentations that universities and government PMs seem to post online to publish their efforts; I've found some interesting materials (and formats) laying about on the Internet from these sources.

D.E.R. Management - IT Project Management Consulting

http://www.dermanagement.com/