Короткий ответ
Документация проекта — не техническое задание на будущее, а карта того, что уже сделано: зачем каждая настройка существует и с чем она связана.
Пять обязательных разделов:
- Карта воронок и стадий.
- Реестр автоматизации — роботы, бизнес-процессы, смарт-процессы.
- Схема прав доступа.
- Интеграции — с чем портал связан снаружи.
- Нестандартные поля — что означают и откуда берутся.
Без любого из них новый интегратор входит на минное поле, а не в понятный проект.
Почему этого почти никогда не делают
Если поспрашивать на рынке, окажется: документацию проекта в этом смысле не ведёт почти никто. Не потому что не знают, что так правильно, — а потому что так устроены стимулы.
Клиент не просит документацию, когда заказывает внедрение. Он просит результат: чтобы воронка работала, чтобы автоматизация делала своё дело. Подрядчик не предлагает документацию сам — это дополнительная работа, которую никто не оплачивает и которая не видна в демонстрации результата.
Исключение — крупные внедрения, где документация явно прописана в требованиях заказчика с самого начала. Там она есть, потому что за неё отдельно платят и отдельно её требуют. На типовом проекте — почти никогда.
Это не критика рынка, а честное описание того, как есть. Минное поле, в которое попадает следующий интегратор, существует именно поэтому: не потому что кто-то поленился, а потому что документация — не то, за что в среднем проекте платят и чего в среднем проекте просят.
Дальше — что должно быть в документе, если вы решите, что он вам нужен, вне зависимости от того, что делает рынок.
Карта воронок и стадий
Не «сколько воронок», а что каждая стадия означает и почему она вообще существует. Стадии без пояснения — самое частое, что новый человек трактует неверно: переименовывает, удаляет, переставляет местами, не понимая, что от них зависит.
Минимум в разделе: название воронки, назначение каждой стадии, что происходит при переходе на неё, кто отвечает.
Реестр автоматизации
Список всех роботов, бизнес-процессов и смарт-процессов с назначением каждого. Не код и не техническая схема — человеческое объяснение: что делает, когда срабатывает, зачем это нужно бизнесу.
Это самый трудоёмкий раздел и самый важный. Робот, привязанный к стадии, исчезает вместе с ней при правке, если о нём не знать заранее — без реестра такие последствия обнаруживаются постфактум.
Отдельно фиксируются связи между элементами: если бизнес-процесс запускает второй бизнес-процесс, это должно быть видно из документа, а не обнаруживаться при правке первого.
Схема прав доступа
Кто что видит и может менять — по ролям, не по именам сотрудников, потому что люди меняются, а роли остаются. Раздутые права — типовая находка на любом аудите, и без документа непонятно, было так задумано или расползлось само.
В разделе фиксируется: какие роли существуют, что каждая видит, кто может назначать роли.
Интеграции
Список всего, с чем портал связан снаружи: 1С, сайт, телефония, рассылки, внешние сервисы. Для каждой — что именно передаётся, в какую сторону, кто отвечает на стороне партнёра.
Без этого раздела новый подрядчик рискует сломать обмен данными, даже не подозревая о его существовании, — интеграция молчит, пока её не заденут.
Нестандартные поля
Поля, которые не входят в штатный набор CRM, — самая частая причина путаницы. Название поля редко объясняет, зачем оно заведено и кто его использует.
В разделе: что означает поле, откуда берутся данные — вручную или автоматически, — кто на него завязан: отчёт, автоматизация, интеграция.
Кто ведёт и кто хранит
Здесь стоит развести два разных вопроса.
Ведёт документацию подрядчик — он лучше всех знает, что настроил, и актуализирует документ по ходу работы, а не разово в конце.
Хранит документацию клиент. Именно клиент переживает смену подрядчиков, а не наоборот. Документ должен жить у него — в доступном месте, не в личном архиве ушедшего исполнителя.
Что делать, если документации не осталось
Восстанавливать по факту, начиная с той зоны, которая нужна прямо сейчас, — ровно тот порядок разбора, что при входе в чужой проект.
Это не бесплатно. Время на восстановление документации стоит так же, как время на саму работу, и его стоит закладывать в проект отдельной строкой сметы, а не прятать внутри других задач.
Как внедрить документирование у себя
- Заведите документ до начала следующего проекта, даже если он пока пустой, — пять разделов сверху.
- Требуйте от подрядчика актуализации после каждого крупного изменения, а не в конце проекта.
- Храните документ у себя, не полагайтесь на архив исполнителя.
- При смене подрядчика передавайте документ вместе с доступами — это часть портала не меньше, чем сами настройки.
Если у вас портал с историей и без документации — поможем восстановить карту и понять, что в нём есть на самом деле.
Если некому держать это в порядке — смотрите сопровождение Битрикс24.