Handover document for complete systems
Posted
by viraptor
on Stack Overflow
See other posts from Stack Overflow
or by viraptor
Published on 2010-06-16T10:51:33Z
Indexed on
2010/06/16
11:02 UTC
Read the original article
Hit count: 235
Hi, I need to create a handover document for a fairly large system consisting of all the stuff you'd expect from a telecom deployment: many servers, database clusters which copy some data between them in specific ways, tons of log files, both off-the-shelf and locally developed software, scripts, network configurations, local know-how, etc. It's really got as many sysadmin-typical elements, as development ones.
The target of this document are in the first place sysadmins who take over the day-to-day operation tasks and some problem resolving, and in the second place people who want to learn about the system in general.
Is there some place I can learn about how to write something like that? It could just as easily be a 10 page "what's where", as a 500 pages book about "all things telephony". Maybe it should be more than one document really.
Please link some useful resources / books I could use for this task.
PS: this is intended to be internal only, customer interactions etc. are out of scope here
© Stack Overflow or respective owner