Хороший runbook — это разница между плавной дежурной сменой и катастрофой в 3:00. С Trupeer вы можете сэкономить часы на написании IT runbook, начав с бесплатного шаблона runbook, настроив его с помощью ваших бренд-гайдлайнов и превращая длинные runbook в видеоинструкции, которые инженеры на дежурстве могут просматривать за секунды.

Что такое бесплатный шаблон runbook?

Бесплатный шаблон runbook — это повторно используемая структура последовательности шагов, которая позволяет выполнить конкретную операционную задачу: развертывание, переключение на резерв, миграцию, восстановление, окно планового обслуживания.

Слово runbook стоит понимать буквально. Это документ, который выполняют, а не читают. Он открыт на экране, пока идет работа, выполняется по порядку, а его ценность — в том, что он делает во время выполнения, а не в том, что в нем написано после сдачи.

Именно этот факт отличает хороший runbook от хорошего документа-процедуры — и именно это чаще всего упускают шаблоны. Они создают хорошо организованное описание того, что нужно делать, что необходимо и составляет примерно половину того, что должен содержать runbook.

Вторая половина в том, что runbook — это форма. Ее заполняют по мере выполнения, потому что запись о том, что на самом деле произошло, и есть то, что отличает операцию, к которой можно подключиться на середине, от той, которую нужно перезапускать или угадывать.

Отсюда и формат. Бесплатный шаблон runbook в Excel подходит для таблицы шагов с колонками результата и временной метки — и именно его чаще всего в итоге используют команды. Бесплатный шаблон runbook в Word подходит для runbook с большим контекстом и прозаическим описанием вокруг шагов, а бесплатный шаблон runbook в Microsoft Word — это то же самое под более длинным названием. Бесплатный шаблон runbook в PDF — это архивная запись завершенного runbook, а не рабочий документ.

Runbook для развертывания или runbook для инцидента?

Два документа носят одно и то же название и используются противоположными способами, поэтому решите, что именно вы пишете.

Шаблон runbook для развертывания описывает плановые работы. Релиз, миграция, переключение, окно планового обслуживания. Он выполняется от первого шага до конца, по порядку, в момент, о котором знали все, обычно несколькими людьми и часто с переходом между сменами. Проблема дизайна — последовательность, состояние и передача.

Runbook для инцидента или дежурства описывает неплановые работы. Что-то пошло не так, и кто-то диагностирует. Его вносят в систему в непредсказуемый момент — тем, кто доступен, под давлением — и его не читают по порядку. Проблема дизайна — быстро найти нужный раздел, поэтому он ближе к документу для поиска, чем к сценарию.

Большинство опубликованных шаблонов смешивают оба подхода и не подходят ни для одного из них. Диагностический runbook, загнанный в нумерованную последовательность, нельзя добавить в середине, а runbook для развертывания, организованный как набор симптомов, теряет порядок, который делает его безопасным.

Эта страница в первую очередь о первом. Плановые работы, выполняемые по порядку, где дорогие сбои связаны с состоянием и передачей, а не с диагностикой.

Как настроить этот шаблон в Trupeer

Шаг 1: Откройте раздел Templates

Перейдите в раздел Templates из главной навигации.

Шаг 2: Выберите и откройте шаблон

Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.

Шаг 3: Разверните просмотр шаблона

При необходимости разверните просмотр шаблона, чтобы четко увидеть полную раскладку и детали.

Шаг 4: Отредактируйте шаблон

Нажмите Edit, чтобы начать изменять выбранный шаблон.

В редакторе вы можете:

• Добавлять новые разделы

• Задавать или обновлять правила форматирования

• Добавить логотип и настроить его позицию и связанные параметры

Шаг 5: Сохраните настроенный шаблон

После того как вы внесете все необходимые изменения, нажмите Save, чтобы сохранить обновленный шаблон как свой.

Шаг 6: Предпросмотр и точная настройка шаблона

Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте Preview.

На экране предпросмотра вы можете продолжить вносить изменения напрямую при необходимости, чтобы шаблон отображался ровно так, как вам нужно.

С шаблоном runbook вы можете:

• Экономить часы на написании: Пропустите пустую страницу — структура уже создана для операционных процедур.

• Сократить MTTR: Понятные runbook помогают инженерам на дежурстве быстрее устранять инциденты.

• Оставаться в фирменном стиле: Применяйте логотип, шрифты и цвета с помощью бренд-набора Trupeer.

• Обучать новых инженеров: Сочетайте runbook с видеоинструкциями, чтобы быстрее вводить в работу сотрудников операционных команд.

• Стандартизировать между командами: Используйте один и тот же формат runbook для каждого типа инцидентов.

• Достигать глобальных команд: Переводите runbook на 65+ языков одним кликом.

Напишите runbook так, чтобы его можно было передать на середине

Вот ограничение дизайна, вокруг которого стоит строить. В какой-то момент во время выполнения человек, который запускает runbook, перестанет быть тем, кто его продолжает.

Смена заканчивается. Кого-то вызывают. Окно выходит дольше, чем планировалось. Для любой операции, длящейся более нескольких часов, это нормально, а не исключение — и именно в этот момент runbook начинают дорого ломаться.

Вопрос, который нужно предусмотреть, сформулирован точно. Сможет ли второй человек подхватить это на шаге тридцать семь без устного брифинга и продолжить безопасно?

Чтобы ответить «да», нужно четыре вещи, которых у большинства шаблонов нет.

Записанный фактический результат на каждый шаг, а не только ожидаемый. Галочка означает, что кто-то что-то нажал. Она не говорит следующему человеку, что именно произошло.

Временная метка на каждый шаг, потому что то, как давно выполнялся шаг, часто является самым диагностическим фактом из доступных.

Явная отметка, какие шаги можно безопасно повторять. Первый вопрос любого, кто принимает эстафету: предыдущий шаг действительно завершился? Если шаг безопасно повторить, то этот вопрос перестает быть критичным — а это стоит гораздо больше, чем цена за запись.

Указанная точка невозврата. После нее откат уже недоступен. Человеку, который приходит на середине выполнения, нужно знать, по какую сторону этой линии он находится, прежде чем он что-либо тронет.

Добавьте эти четыре пункта — и устная передача перестает быть механизмом. Документ становится передачей, и это единственная версия, которая переживает ситуацию, когда кто-то устал, спешит или недоступен.

Что должен содержать шаблон runbook

Девять компонентов. Средние четыре — это то, что отличает runbook от процедуры.

Последний пункт заслуживает особого внимания. Шаги проверки, написанные как «подтвердите, что сайт работает», проходят, когда сайт работает, но сломаны, — то есть это тот сбой, который описан ниже.

Бесплатный шаблон runbook: структура для копирования

Заполнено реальным примером, а не плейсхолдерами. Это фрагмент миграции системы управления заказами.

Скопируйте отсюда.

Заголовок и окно. Название run, дата, плановое окно, дедлайн на прерывание и версия этого runbook.

Миграция системы управления заказами. Суббота, 14 июня. Окно 06:00–20:00. Дедлайн на прерывание 16:00, после чего мы откатываемся независимо от прогресса. Runbook v9.

Роли для этого run. С номерами в документе.

Выполнение: K Ferreira 06:00–14:00, затем D Attwood 14:00–20:00. Точка невозврата утверждена: Head of Engineering, 07700 900xxx. Эскалация: lead дежурной платформы, 07700 900xxx. Контакт со стороны бизнеса для решения «go»: Trading Director.

Предпосылки. Все подтверждено до шага один.

Полная резервная копия базы данных сделана и восстановление протестировано на standby-инстансе. Заморозка кода действует с четверга. Оба исполнителя имеют доступ к production, проверено сегодня, не предполагается. Откат репетировался на staging 7 июня.

Строка статуса. Обновляется по мере выполнения, остается в верхней части.

Сейчас на шаге 37. Выполняется с 13:48. Исполнитель: K Ferreira. Точка невозврата еще не пройдена.

Таблица шагов.

Откат. Доступен до и включая шаг 37. Восстановить из резервной копии до run, перенаправить DNS, перезапустить обработчиков входящих ордеров. Репетировалось на staging 7 июня D Attwood.

Раздел передачи. Заполнен до того, как уйдет кто-либо.

Завершено до шага 35. На первой попытке шаг 34 завершился молча с несоответствием количества и был повторно выполнен успешно, теперь количество совпадает — 84,120. Следите за количеством индекса снова после шага 36, так как он уже один раз не сработал. Ничего не выполняется прямо сейчас. Точка невозврата не пройдена, откат все еще доступен.

Проверка. Достаточно конкретно, чтобы выявить сбой.

Сайт загружается. Количество продуктов на страницах категорий суммируется до 84,120. Десять тестовых заказов размещены end-to-end. История заказов видна для пяти известных аккаунтов. Отчет по сверке платежей сформирован и совпадает.

Скопируйте отсюда.

Пример runbook: шестьдесят один шаг и десятиминутная передача

Tamworth Retail Group, онлайн-ритейлер, перенесла систему управления заказами во время планового окна длительностью четырнадцать часов в субботу.

У runbook было шестьдесят один шаг. Его проверили, репетировали на staging, и это был действительно аккуратный документ. В таблице шагов было три колонки: номер шага, действие и поле для галочки.

Первый инженер выполнил шаги с первого по тридцать седьмой, передал устно примерно за десять минут на смене и ушел домой после долгого дня.

Шаг тридцать четыре — это переиндексация каталога продуктов, задание занимало около сорока минут. Он начал его, не увидел ошибок и поставил галочку. На самом деле оно не сработало примерно на восьмидесяти процентах и не сообщило ничего.

Второй инженер пришла к списку из шестидесяти одного шага с галочками напротив первых тридцати семи. Не было записи о том, что произвел каждый шаг, не было временных меток и не было указаний, какие шаги можно безопасно повторять. Все до шага тридцать восемь, с точки зрения документа, просто было сделано.

Она продолжила. Каталог был проиндексирован частично, то есть примерно двенадцать процентов продуктов были невидимы на сайте, когда его открыли снова.

Проверка в конце подтвердила, что сайт загружается. Она не сравнивала количество продуктов с количеством в каталоге, поэтому тест прошел.

Никто не заметил этого до понедельника утром, через тридцать один час, в самый загруженный торговый уикенд квартала. Оценка потерянных заказов по сравнению с тем же уикендом прошлого года составила около двухсот сорока тысяч фунтов.

Откат сделать было нельзя. Точка невозврата была пройдена на шаге сорок один, и хотя все участники знали об этом в принципе, это было записано абзацем на первой странице, а не на том шаге, где это произошло.

Переписывание не добавило шагов. Оно добавило колонки. Фактический результат, временная метка и отметка «можно повторять» на каждом шаге. Строка статуса вверху. Точка невозврата переместилась из введения на сам шаг — жирным. И раздел передачи, который нужно заполнить до того, как уйдет кто-либо: он превратил десятиминутный разговор в четыре строки текста.

На следующей миграции смена произошла на девятом часу. Передача заняла четыре минуты. Инженер, которая принимала эстафету, повторно выполнила три шага, в которых она не была уверена, — именно потому, что они были отмечены как безопасные для повторного выполнения, — и runbook завершился в пределах окна.

Повторить три шага из осторожности — это несколько минут. Невозможность повторить — это стоимость целого уикенда.

Как написать runbook за шесть шагов

1. Запишите шаги, выполняя задачу, а не по памяти. Runbook, написанный за столом, содержит шаги, которые помнит автор, и пропускает те, которые руки делают автоматически.

2. Дайте каждому шагу ожидаемый результат. То, что вы увидите, будет означать, что все сработало. Шаг без ожидаемого результата невозможно проверить никому, кроме его автора.

3. Отметьте каждый шаг как безопасный для повторного выполнения или нет. Описано ниже. Это самая дешевая колонка для добавления и самая ценная во время передачи.

4. Укажите точку невозврата на шаге, жирным. Не во введении, где ее один раз прочитает человек, который не является тем, кому она нужна.

5. Добавьте колонки, которые вы заполняете во время run. Фактический результат и временная метка. Если их нет в документе, они не будут записаны нигде.

6. Отрепетируйте это, включая откат. Откат, который только записали, — это предположение. Репетируйте на staging вместе с человеком, который будет выполнять, а не с тем, кто это написал.

Шаг первый — это тот, который отделяет полезные runbook от правдоподобных. Писать во время выполнения — значит поймать незадокументированный клик, учетные данные, которые уже лежали в буфере обмена, и вкладку, которую нужно было держать открытой.

Отметка шагов как безопасных для повторного выполнения и точка невозврата

Эти две отметки делают большую часть работы во время передачи, и ни одна из них не встречается в типичном шаблоне.

Безопасно повторять. Для каждого шага: можно ли выполнить его дважды без вреда. Перезапуск остановленного сервиса, повторная индексация, повторное применение конфигурации, которая уже применена: обычно да. Отправка письма клиенту, инкремент счетчика, миграция строк в таблицу, которая не удаляет дубликаты: обычно нет.

Ценность в том, что это убирает вопрос, на который человек, принимающий эстафету, не сможет ответить. Завершился ли предыдущий шаг. Если ответ не важен, потому что повторять безопасно, то никому не нужно выяснять это под давлением при неполной информации.

Если шаг нельзя безопасно повторять, скажите, что нужно проверить в первую очередь. «Нет, проверьте количество строк перед повтором» гораздо полезнее, чем «Нет», потому что человек, который это читает, уже решил, что ему нужно что-то сделать.

Точка невозврата. У каждого run, который меняет состояние, есть своя. Это шаг, после которого откат больше недоступен или больше не дешевле, чем продолжать.

Отметьте ее на шаге — визуально отличимо, чтобы человек, который прокручивает документ, мог понять, по какую сторону он находится. Назовите того, кто авторизует прохождение, и зафиксируйте время прохождения в колонке фактического результата. Во многих run точек невозврата больше одной — тогда отметьте каждую и скажите, что она закрывает.

Причина фиксировать именно момент пересечения, а не только сам шаг, в том, что после инцидента задают вопрос, когда решение стало необратимым, и никто не помнит.

Варианты шаблонов runbook

Структура сохраняется, а акценты смещаются.

Шаблон runbook для развертывания. Пример выше. Последовательный вариант: плановые работы, выполняемые по порядку, часто с переходом между сменами, и вариант, где дизайн передачи важнее всего.

Runbook для аварийного восстановления. Выполняется редко и в худших условиях, поэтому между использованиями «портится» незаметно. Отличительное требование — запланированная репетиция: DR runbook, который не выполняли в течение года, следует считать неверным.

Runbook для дежурства и инцидента. Его вносят в систему в непредсказуемый момент, а не выполняют по порядку. Организуйте по симптомам, а не по последовательности, держите каждую запись короткой и давайте ссылки на более глубокие материалы вместо того, чтобы включать их в документ.

Runbook для планового обслуживания. Повторяется регулярно, поэтому это единственный вариант, который действительно улучшается за счет использования — при условии, что кто-то обновляет его во время run, а не планирует сделать это потом.

Runbook для онбординга и офбординга. Часто это первый runbook, который пишет команда, потому что последовательность стабильна, а стоимость пропуска шага, особенно при офбординге, — это проблема безопасности, а не неудобство.

Для всего, что касается регулируемых систем, финансовой обработки или контроля, связанного с безопасностью, runbook обычно находится внутри процесса управления изменениями с собственными требованиями к утверждению и ведению записей — и именно они управляют, а не что-либо на этой странице.

Runbook, рабочая инструкция или SOP?

Три документа пересекаются и их стоит разделять, потому что при неверном выборе получается правильный контент, но в непригодном формате.

Стандартная операционная процедура описывает процесс на уровне того, кто что делает и в каком порядке, обычно с охватом ролей и часто на протяжении дней. Ее читают для понимания.

Рабочая инструкция описывает одну задачу подробно для человека, который ее выполняет, и написана так, чтобы ее мог выполнить тот, кто может быть с ней незнаком. Шаблон рабочих инструкций описывает этот документ.

Runbook — это рабочая инструкция, которая также является записью выполнения. Ее выполняют и заполняют одновременно: обычно она охватывает несколько задач в заданном порядке, а ее колонки существуют, чтобы оставить след.

Если документ читают до работы и подшивают после, это процедура. Если он открыт во время работы и в конце отличается от того, каким был в начале, это runbook.

Как поддерживать runbook в актуальном состоянии

Runbook «стареют» быстрее, чем большинство документации, потому что они описывают системы, которые меняются, а это становится заметно только после того, как run, который не сработал, наконец случается.

Механизм, который реально работает, — обновлять документ во время выполнения, а не после. Тот, кто запускает runbook, держит документ открытым, только что обнаружил, что на шаге двенадцать теперь нужна дополнительная верификация, и это единственный человек, который когда-либо узнает об этом дешево. Через десять секунд — или через час путаницы на следующем run.

Сделайте это легитимным, явно указав это в верхней части документа, и относитесь к неизмененному runbook после реального выполнения с легким подозрением, а не как к признаку качества.

Есть и другой путь — автоматизация, и к ней стоит относиться трезво. Автоматизация шага runbook убирает сразу и человеческую ошибку, и проблему документации — это действительно лучше там, где применяется. Но она не убирает необходимость окружающего документа, потому что кто-то все равно должен знать, что делать, когда автоматизация не сработает, и теперь этот человек менее натренирован, чем раньше. Автоматизируйте шаги, сохраняйте runbook и убедитесь, что runbook покрывает ту часть, которая автоматизирована и может не сработать.

Что бесплатный шаблон runbook не может исправить

Runbook, написанный по памяти. Ни один шаблон не показывает шаги, которые автор делает, не задумываясь. Только запись во время выполнения.

Откат без репетиции. План отката, который никогда не выполняли, — это гипотеза, а середина провалившейся миграции — плохое место, чтобы это проверять.

Чеклист под названием. Большая часть того, что распространяют как бесплатный шаблон runbook для скачивания, — это нумерованная процедура с чекбоксами, то есть другой и более слабый документ.

Проверка, которая не может не пройти. «Подтвердите, что сайт работает» проходит, когда сайт работает, но неправильно. Каждый шаг проверки должен быть достаточно конкретным, чтобы вы могли представить, как он может не сработать.

Окно без дедлайна на прерывание. Без него run, который идет плохо, продолжается, потому что остановиться всегда кажется дороже, чем сделать следующий шаг. Установите дедлайн до начала, когда никто еще не вовлечен.

Показывайте run, а не описывайте его

Runbook выполняют люди, которые делают это редко. Миграция происходит дважды в год. Тест DR — раз в год. Человек, который выполняет, делал это один раз раньше, возможно, вообще никогда.

Именно в этом случае хуже всего работает написанная процедура, потому что читателю приходится восстанавливать последовательность экранов и состояние консоли по прозе, а разрыв между тем, что имел в виду автор, и тем, что представляет читатель, — это место, где прячется незадокументированный шаг.

Trupeer AI закрывает эту проблему. Кто-то выполняет run один раз на staging, записывая процесс, и результат — это пошаговый текстовый walkthrough со скриншотами, которые уже сняты и размещены, вместе с видео, в вашем собственном фирменном стиле. Текстовая версия становится runbook. Видео — это то, что человек, который выполняет, смотрит накануне, то есть это подготовка, которой сейчас никто не успевает заниматься.

Запишите. Оформите в фирменном стиле. Переведите. Trupeer it.

Две вещи особенно важны именно для runbook. Репетиция превращает документацию в побочный продукт, а не в дополнительную задачу — и это единственная версия документации, которая надежно появляется. А когда инфраструктура меняется, повторная запись репетиции быстрее, чем редактирование скриншотов, поэтому runbook с большей вероятностью будет актуальным в тот момент, когда это действительно важно.

Материалы лежат в вашем knowledge base и одновременно служат обучением для того, кто будет следующим в ротации. Доказательства проверки и контроль качества вокруг run должны быть в QA plan. Согласованность с вашими другими документами — это вопрос один раз настроить бренд-набор, а настройка описана в руководстве по настройке шаблона документа.

Часто задаваемые вопросы

Есть ли бесплатная версия шаблона runbook в Excel?

Excel — это то, чем в итоге пользуется большинство команд, и он хорошо подходит для документа, потому что основа runbook — это таблица, которую заполняют во время работы. Файл бесплатного шаблона runbook в Excel естественно обрабатывает колонки шага, ожидаемого результата, фактического результата, временной метки и «можно повторять», а также позволяет нескольким людям видеть одну и ту же таблицу во время run.

Есть два практичных режима. Зафиксируйте строку заголовка и поместите строку статуса в первые две строки над ней, чтобы она оставалась видимой при прокрутке. Бесплатный шаблон runbook в Excel, где текущий шаг прокручивается из видимой области, теряет большую часть ценности передачи.

Есть ли бесплатная версия шаблона runbook в Word?

Word подходит для runbook с существенным контекстом вокруг шагов: заметки по архитектуре, история решений, детали эскалации. Сначала создайте файл бесплатного шаблона runbook в Word с повествовательными разделами, а затем добавьте таблицу шагов.

Ограничение — заполнение во время run. Таблица Word обновляется медленнее, чем ячейка в таблице, и во время живой миграции это трение достаточно, чтобы остановить людей от записи фактических результатов. Многие команды хранят контекст в документе шаблона runbook Word, а таблицу шагов — в таблице, связанной с ним.

Есть ли бесплатная версия шаблона runbook в Microsoft Word?

Да, и действует то же самое компромиссное решение. Бесплатный файл шаблона runbook в Microsoft Word — правильный выбор, когда runbook рассматривают и утверждают как часть процесса управления изменениями, потому что документы лучше вписываются в рабочие процессы утверждения, чем таблицы.

Если вы пойдете этим путем, все равно добавьте колонки фактического результата и временной метки. Runbook, утвержденный без них, будет выполняться без них, и нужной записи просто не будет.

Есть ли шаблон runbook для развертывания?

Шаблон runbook для развертывания — это последовательный вариант, описанный на этой странице: плановые работы, выполняемые по порядку, обычно с переходом между сменами.

Четыре вещи отличают хороший вариант от универсального шаблона. Точка невозврата отмечена на шаге, а не во введении. Отметка «можно повторять» на каждом шаге. Колонки фактического результата и временной метки. И раздел передачи, который заполняют до того, как уйдет кто-либо. Почти ни один опубликованный шаблон не содержит ни одного из этих четырех пунктов.

Есть ли бесплатный шаблон runbook в PDF?

PDF — это архив, а не рабочий документ. После завершения run экспортируйте заполненный runbook как бесплатный шаблон runbook в PDF и прикрепите его к записи об изменении, потому что завершенный runbook с временными метками и фактическими результатами — это лучшее доказательство того, что произошло.

Не выполняйте из PDF. Документ должен быть написан во время run, и все, что вы не сможете ввести, не будет записано.

Есть ли бесплатный шаблон runbook для скачивания, который стоит использовать?

Сама таблица занимает десять минут на сборку, поэтому бесплатный шаблон runbook для скачивания экономит немного, а большинство опубликованных — это документы-процедуры с ярлыком runbook.

Проверьте одну вещь перед тем, как принять любой из них. Посмотрите, есть ли в таблице шагов колонка для того, что произошло на самом деле. Если там только чекбокс, у вас чеклист, а весь аргумент этой страницы в том, что разница между этими двумя — это то, от чего зависит передача.

Какой длины должен быть runbook?

Столько же, сколько длится run, а для существенной миграции это действительно десятки шагов. Длина — не проблема runbook.

Контролировать нужно размер шага. Шаг должен быть одним действием с одним наблюдаемым результатом. Шаги, которые объединяют несколько действий, нельзя передать на середине, потому что следующий человек не сможет понять, сколько из набора уже произошло, и именно для предотвращения такой ситуации существует документ.

Кто должен писать runbook?

Тот, кто будет его выполнять, записывая во время выполнения в не production-среде. Runbook, написанный архитектором и выполняемый инженером, будет пропускать ровно те шаги, которые архитектор лично не выполняет.

Затем пусть второй человек выполнит черновик на staging без помощи автора. Любой вопрос, который им придется задать, — это дефект, а исправление — записать его, а не отвечать на него.