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

Передача проекта

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

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

Сопроводительная записка

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

Используйте этот шаблон.

  1. О данной настройке. Клиент, организация в CoRoid, дата и исполнители. Где хранятся документ об обнаружении и экспортированные файлы.
  2. Что настроено. Для каждой области Настроить измененные вами параметры: укажите значение настройки в одной строке. Не включайте области, использующие стандартные значения, и отметьте, что они применяются.
  3. Почему. Для каждой настройки укажите правило из документа об обнаружении, которому она соответствует. Настройка без обоснования — это настройка, которую никто не решается изменить.
  4. Как ее изменить. Для каждой настройки укажите, где она находится и кто может ее изменять. Также назовите файлы в репозиториях: AGENTS.md, REVIEW.md, review-rules папку и требуемые навыки.
  5. На что обратить внимание. Показатели из пилотного этапа, что считается хорошим значением и что делать при его нарушении. Укажите, кто отвечает Требует вашего участия.
  6. Открытые задачи. Запросы, отправленные в CoRoid, и исключения из чек-листа запуска в эксплуатацию — каждый с указанием даты.

Экспортировать настройки и рабочие процессы

  • Пакет настроек. Экспортируйте его в Настройки → Данные и юридические вопросы → Экспортировать настройки. В пакете зафиксирована структура настроек организации. Секретные данные в нем представлены лишь плейсхолдерами, поэтому в нем нет ключей или токенов. Подробнее см. Экспорт и импорт настроек.
  • Каждый рабочий процесс. Откройте рабочий процесс, затем выберите Дополнительные действия → Экспортировать. В файле содержатся шаги и пути рабочего процесса, таблицы правил, тестовые ситуации и названия необходимых инструментов. В нем нет секретов и конфиденциальных данных.

Передайте файлы клиенту вместе с запиской. Клиент сохранит их в собственных системах, например в репозитории. Сами не оставляйте копий. Файлы являются подтверждением того, что вы поставили.

Удалить или ограничить внешний доступ

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

  1. Каждый консультант отзывает созданные им токены доступа в рамках Настройки → Подключения → CoRoid MCP сервер → Токены доступа.
  2. Клиент удаляет каждого консультанта в Настройки → Участники, или назначает ему более низкую роль, которую клиент решит сохранить.
  3. Проверьте Настройки → Идентификация и доступ → Активные сессии на предмет сессий ушедших сотрудников.
  4. Убедитесь, что ни одно подключение не использует личный токен консультанта. Замените такие подключения на подключения от имени клиента.

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

  • Клиент получил записку и экспортированные файлы.
  • Доступ каждого консультанта удален или намеренно ограничен.
  • Сотрудник, отвечающий за настройки, прочитал записку.