Post History
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...
Answer
#4: Attribution notice removed
by
System
·
2020-01-03T20:41:50Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/24927 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#3: Attribution notice added
by
System
·
2019-12-08T05:39:58Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/24927 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
System
·
2019-12-08T05:39:58Z (almost 5 years ago)
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.
#1: Imported from external source
by
System
·
2016-10-13T12:12:23Z (about 8 years ago)
Original score: 1