Чек-лист, регламент или база знаний
Заказчик почти никогда не формулирует задачу как «нужен чек-лист» или «нужна база знаний» — он говорит «нужна документация». И получает текст, которым никто не пользуется, потому что формат выбран не под задачу, а по инерции: раз документ важный, значит это регламент.
Формат определяется двумя вопросами: предсказуема ли последовательность действий и есть ли в процессе развилки.
Чек-лист работает, когда последовательность фиксирована, а результат бинарный — сделано или нет: открытие смены, деплой, приёмка оборудования. Как только появляется «если A — делай так, если B — иначе», чек-лист перестаёт справляться: развилки превращаются в сноски, которые никто не читает.
Регламент нужен там, где есть развилки и ответственность за решение — эскалация инцидента, работа с жалобой. Но регламент, написанный как связный рассказ, работает только на бумаге: в реальной ситуации от него нужны не абзацы, а явные условия «если — то» и точки входа по типу ситуации.
База знаний закрывает третий случай — обращения нерегулярные и непредсказуемые по времени: настройка редкого сценария, вопрос, который всплывает раз в квартал. Здесь работает не последовательное чтение, а поиск: заголовки, теги, ключевые слова, совпадающие с тем, как человек формулирует проблему.
Прежде чем заказывать документацию, стоит определить не тему, а тип обращения к ней — это и определяет формат.
Материал написан на основе опыта администрирования IT-инфраструктуры и составления технической документации.