Runbook template example?
I have been searching for a Runbook / Operations Guide example and can't seem to find a useful one for my company. The current runbook they handed me contains use cases and requirements, which I know shouldn't be in one; however, I can't find a good example to show to my managers and say, "This is what we should be using."
Any ideas where I can find one or any quick and dirty examples someone can give me in an answer here?
Thanks!
This post was sourced from https://writers.stackexchange.com/q/24897. It is licensed under CC BY-SA 3.0.
2 answers
I don't have a good example for this either, but my suggestion is that requirements do not go into a Runbook/Operations manual, but that the use cases would make a lot of sense, as you would be tying the steps needed to complete a function to the use case that the user is trying to accomplish from a business or technical sense. The manual then becomes a set of directions tied to the problem the user is trying to solve or the business process they are trying to complete.
This post was sourced from https://writers.stackexchange.com/a/24933. It is licensed under CC BY-SA 3.0.
0 comment threads
In the end, every technical document should contain whatever information the users need to get their jobs done. This takes precedence over any template or convention.
To the extent that there are standard templates for a technical document it is because it is often difficult to tell what information users need. If you can't get information on what your particular users need, you can fall back on a general template that you hope is based on experience with real users (though in many cases they are based on a bunch of people sitting in a room guessing).
A Runbook, however, is an internal document. You have direct access to the audience for your company's runbook and can directly observe the work they do. What your IT staff need in your organization may be significantly different from a standard template. You can base your runbook on what they actually need and use.
0 comment threads
0 comment threads