---
# System prepended metadata

title: Runbook's Readme

---

# Runbook's Readme

This readme is an introduction to runbooks.  

## Description

### General Description
A runbook is a detailed “how-to” guide for completing a commonly repeated task or procedure within a company's IT operations process. Runbooks are created to provide everyone on the team new or experienced the knowledge and steps to quickly and accurately resolve a given issue.

### Our Description
Runbooks are systemic plans to guide you step by step **to react** and resolve specific incidents.   

Runbooks give you a **set of instructions** and infos that are needed in order to get your system working again.

## Usage
Read **carefully** each runbook paragraph before taking action. It is important to understand if you have the permission and knowledge to perform the operations requested.

## How to Build
In order to build your personal Runbook, follow these points:

- Write the document using Markdown, it aids with legibility and cross compatibility
- Clarify the use of common jargon used inside the runbook
- Add a table of contents at the top of the runbook, it allows the user to skip through the document if needed
- Make sure all the necessary steps are in the list of things to do
- Describe each step as thoroughly as possible: it will save a lot of time in the long run
- If necessary you can add images or GIFs to further explain what to do, but don't overdo it! It could easily become visual clutter, especially to someone in a hurry
- Try to be as clear and concise as possible without omitting any details
- Having the user copy-paste blocks of pre-written code can save quite a bit of time and help avoid any mistakes
- Include who created the runbook and when, the user who last updated it and when that happened, the runbook's version, who last verified the runbook and when
- Use the common template _(linked below)_

## Template
Follow [this](https://hackmd.io/@_ooqt_RiROyqi2rasH2w0Q/rJkgx6vVj/edit) template as closely as possible to maximise readibility for users

## License
[Storvix AB](https://storvix.eu/)
