Документация

Откройте для себя

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

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

С кем поговорить

  • Человек, принимающий решения от имени заказчика и отвечающий за организацию в CoRoid.
  • Руководитель команды разработки для каждого репозитория, в котором будет работать CoRoid.
  • Люди, которые сейчас проверяют и объединяют pull-запросы.
  • Требования к безопасности или соответствию, если у заказчика есть правила относительно данных, моделей или процедур утверждения.
  • Владелец каждого бизнес-процесса, который будет охвачен рабочим процессом.

Вопросы для уточнения

Спрашивайте о результатах и опасениях, а не о настройках. Заказчик может сказать: «Никто не меняет код расчёта оплаты без предварительной проверки». Настройку вы найдёте позже.

Цели

  • Что должно измениться через 90 дней? Уточните показатель и его текущее значение, например: «Ошибки в отчётах исправляются в течение недели».
  • Какую работу должен выполнять CoRoid в первую очередь? Какую работу ему категорически нельзя выполнять?
  • Кто сейчас заказывает работу? Кто будет обращаться к CoRoid за выполнением задач?

Системы

  • Какой хост Git и какие репозитории используются? Может ли CoRoid подключиться к хосту Git через публичный интернет?
  • Как в каждом репозитории собирается и запускается тестирование? Какие сервисы необходимы для тестирования?
  • Как сейчас осуществляется вход в систему? Использует ли компания поставщика удостоверений личности совместно с SSO?
  • Какой чат-инструмент использует команда?
  • Откуда сейчас поступают задачи: из трекера задач, трекера ошибок, почты поддержки или инструмента мониторинга?
  • Какие внутренние системы должны быть доступны агентам для чтения или изменения? Есть ли для них сервер MCP?
  • Как код попадает в продакшн? Кто осуществляет деплой и в какие дни?

Правила

  • Где должны храниться данные? Должны ли запросы к моделям AI обрабатываться только в пределах ЕС?
  • Какие поставщики моделей разрешены? Есть ли у заказчика собственные контракты и ключи для доступа к поставщикам моделей?
  • Какой код требует утверждения конкретного человека перед объединением? Кто даёт такое разрешение?
  • Что обязательно должно пройти каждая правка: тесты, покрытие кода, сканирование на уязвимости, переводы?
  • Что может инициировать CoRoid без участия человека? Какой бюджет ему выделен на неделю или месяц?
  • Что должно фиксироваться в журнале аудита и как долго эти записи должны храниться?

Процессы

  • Какие бизнес-процессы может охватить рабочий процесс? Для каждого из них укажите: как начинается случай, какие шаги выполняются и какие решения требуют участия человека.
  • Какие правила определяют остальные действия? Опишите их в виде строк: «при условии X — действие Y».
  • Что должно произойти при сбое, например при неудачном выполнении задачи или деплоя?
  • Какая работа должна выполняться по расписанию, например еженедельная очистка?

Люди

  • Кто являются владельцами и администраторами? Кто заказывает работу, а кто только проверяет её?
  • Кто будет обслуживать настройки после передачи проекта?

Документ-описание

Сделайте документ кратким. Используйте следующие разделы в таком порядке.

  1. Цели. Результаты через 90 дней, каждый с указанием показателя и его текущего значения.
  2. Системы. Хост Git и репозитории, способ входа, чат, трекеры задач и ошибок, внутренние инструменты и процесс выпуска в продакшн.
  3. Правила. Где хранятся данные, разрешённые модели, требования к утверждению, проверки, которые должна пройти каждая правка, бюджет, аудит и хранение данных.
  4. Процессы для охвата. Для каждого проекта и рабочего процесса укажите, что он охватывает, кто за него отвечает и как убедиться в его корректной работе.
  5. Люди. Роль каждого человека в CoRoid и кто будет обслуживать настройки после передачи проекта.
  6. Открытые вопросы. Что ещё должен решить заказчик и к какому сроку.

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

Готово, когда

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