Паспорт эксплуатации бота
Соберите сведения, без которых поддержка превращается в поиск ответственного. Шаблон не предназначен для хранения паролей.
Заполните пункты для своего проекта. Так первое обсуждение начнётся с конкретных требований.
01. Владелец, ответственные и контакты команды.
Укажите владельца аккаунта MAX и ответственных за код, инфраструктуру и каждую интеграцию. Запишите рабочий способ связи и согласованный порядок передачи задачи, не подменяя его неподтверждённым обещанием круглосуточной реакции.
02. Репозиторий, инфраструктура и документация.
Соберите ссылки на репозиторий, инструкции выпуска, схему сервера и место хранения журналов. В паспорте указывают владельца доступа и способ его получения; пароли, токен бота и ключи в документ не вставляют.
03. Интеграции и критичные пользовательские действия.
Выделите критичные операции: создание заявки, получение статуса, запись или отмена. Для каждой укажите источник сигнала об ошибке; отдельно проверьте HTTPS, подтверждение Webhook, повторную доставку событий и защиту от дублирующей обработки.
04. Обновления, резервирование и восстановление.
Опишите, что резервируется и кто проверяет восстановление. Дата последней копии сама по себе не доказывает восстановимость: нужен согласованный тест возврата данных и запуска сервиса с понятным результатом.
05. Порядок сообщения о сбое и проверки исправления.
Подготовьте шаблон сообщения о сбое: время, шаги, ожидаемое и фактическое поведение, обезличенный идентификатор события. После исправления повторите исходный сценарий и связанные операции; запишите версию выпуска и способ возврата при новой ошибке.