Перейти к основному содержимому

Confluence

Аналитику Архитектору Руководителю Техническому писателю
Теория данных (раздел 3)

ERD — Entity Relationship; SQL — SQL для аналитики, SQL; миграции — Пакетная работа. Полная таблица — о разделе.

Документация аналитикачто писать; здесь — где вести в Confluence, чтобы страницы не стали свалкой.


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

Нужно, чтобы:

  • не терять информацию и не искать нужный файл в почте или переписке;
  • не путать версии документов, если они разнятся;
  • иметь целостный контекст;
  • получить интеграцию с задачами в Jira.

Как им пользоваться:

  • создать пространство как отдельную папку для проекта или отдела;
  • добавлять страницы - одна страница - одна тема;
  • форматировать прямо в браузере, как в Word (заголовки, таблицы, картинки);
  • вставлять диаграммы через макросы (Draw.io/Mermaid кодом);
  • связывать страницы, ставить ссылки на другие страницы или задачи Jira;
  • комментировать, обсуждать прямо под текстом, а не в чате;
  • смотреть историю изменений, кто когда и что менял.

Play ITЗагрузка интерактивного демо…


Роль документации и контекстуализации в аналитической деятельности

Аналитическая работа в сфере информационных технологий невозможна без систематической фиксации знаний, требований, гипотез, архитектурных решений и принятых соглашений. Документирование — один из центральных элементов аналитической практики. Оно обеспечивает преемственность, согласованность, проверяемость и многократное использование результатов анализа как внутри команды разработки, так и за её пределами — со стороны заказчиков, эксплуатационных служб, регуляторов или аудиторов.

Среди множества инструментов, применяемых для хранения и структурирования документации, Atlassian Confluence занимает особое место. Это полноценная платформа для совместной работы над контентом, ориентированная на жизненный цикл проекта, управление знаниями и координацию между ролями. Для аналитика Confluence становится центром сбора, обработки, верификации и распространения информации — пространством, в котором формируется контекст проекта.


Confluence как среда фиксации и развития контекста

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

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


Функциональные возможности Confluence, релевантные аналитику

Структурирование пространства знаний

Confluence организует контент в так называемые "пространства" (spaces) — логически обособленные зоны, соответствующие проекту, направлению, команде или организационной единице. Аналитик может создавать иерархию страниц внутри пространства, отражая этапы аналитической работы: от этапа исследования и сбора требований до формализации спецификаций и технических предложений. Возможность создания страниц-шаблонов позволяет стандартизировать форматы артефактов — технические задания, протоколы интервью, аналитические записки, карты процессов и т.д.


Встроенная поддержка визуализации

Хотя Confluence не является специализированным инструментом моделирования, он поддерживает встраивание диаграмм и схем через внешние сервисы (например, draw.io, Lucidchart) или через собственные элементы (например, макросы для таблиц, досок и блок-схем). Особенно ценным является поддержка синтаксиса Mermaid — языка описания диаграмм в виде текста. Это позволяет включать BPMN-подобные диаграммы процессов, последовательности, архитектурные схемы и графы зависимостей непосредственно в текст документа, сохраняя редактируемость и версионность.


Совместная работа и контроль версий

Confluence обеспечивает полноценную поддержку совместного редактирования — несколько участников могут одновременно работать над документом, видеть изменения в реальном времени, оставлять комментарии, обсуждать формулировки и утверждать решения. История изменений каждой страницы сохраняется, что позволяет отслеживать эволюцию требований, возврат к предыдущим состояниям или аудит решений. Это особенно важно в условиях частых изменений требований и необходимости подтверждения согласованности между бизнесом и технической командой.


Интеграция с Jira и другими инструментами экосистемы Atlassian

Наиболее сильная сторона Confluence — его глубокая интеграция с Jira. Аналитик может связывать страницы документации с задачами, эпиками, багами и спринтами. Например, описание пользовательской истории в Confluence может быть привязано к соответствующему тикету в Jira, а каждая задача — содержать ссылку на техническое описание, принятое решение или протокол обсуждения. Это создаёт единое информационное поле, в котором документация является неотъемлемой частью рабочего процесса.

Помимо Jira, Confluence может интегрироваться с Bitbucket (для ссылок на код и пул-реквесты), с BI-системами (через iframe или API-виджеты), с внешними хранилищами файлов и даже с корпоративными чатами (например, Slack или Microsoft Teams), обеспечивая сквозной поток информации.


Аналитические сценарии использования Confluence

Сбор и структуризация требований

На ранних этапах проекта аналитик сталкивается с необходимостью обработки неструктурированной информации — интервью с заказчиками, записи встреч, выдержки из регламентов, скриншоты существующих систем. Confluence позволяет создавать "черновые" страницы для таких материалов, постепенно превращая их в структурированные артефакты. Например, страница "Протокол интервью с заказчиком по модулю расчёта заработной платы" может содержать стенограмму, выделенные тезисы, ссылки на соответствующие бизнес-процессы, идентифицированные боли и предварительные гипотезы по улучшению.

Со временем такие страницы трансформируются в формализованные документы — например, в "Описание предметной области — Расчёт заработной платы", где уже присутствует глоссарий, ключевые сущности, правила расчёта, ограничения и ссылки на нормативные документы. Такой подход обеспечивает прослеживаемость: от исходного запроса до окончательной формулировки требования.


Формализация пользовательских историй и спецификаций

Confluence позволяет выйти за пределы краткого формата пользовательской истории ("Как <роль>, я хочу <цель>, чтобы <выгода>"), дополняя её контекстом, примерами сценариев использования, граничными случаями, ограничениями и негативными тест-кейсами. Аналитик может создать шаблон "Расширенное описание пользовательской истории", включающий:

  • Контекст и мотивация;
  • Связанные бизнес-процессы;
  • Диаграммы последовательности или потока данных;
  • Форматы входных/выходных данных;
  • Связь с метриками эффективности (OKR, KPI);
  • Ссылки на нормативные или юридические требования.

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


Архитектурное и техническое согласование

Аналитик нередко выступает посредником между бизнесом и технической командой. Для согласования решений создаются страницы с описанием альтернатив, оценкой рисков, обоснованием выбранного варианта и последствиями отказа от других. Такие документы часто называют ADR (Architectural Decision Records), и Confluence — естественная среда для их ведения. Аналитик может зафиксировать решение и обеспечить его прослеживаемость — какие требования повлияли на выбор, какие сценарии оно покрывает, какие компромиссы были приняты.


Управление глоссарием и онтологией предметной области

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


Типичные артефакты аналитика в Confluence

Хотя конкретный набор артефактов зависит от методологии и масштаба проекта, можно выделить ряд повторяющихся видов документации:

  • Vision & Scope — описание общей цели проекта, границ, ключевых целей и исключений;
  • Stakeholder Map — карта заинтересованных сторон с описанием их ролей, потребностей и уровня влияния;
  • User Personas — профили целевых пользователей с мотивациями, болевыми точками и сценариями взаимодействия;
  • User Journey Maps — описание пользовательских путей с выделением точек взаимодействия, эмоций и возможностей для улучшения;
  • Business Process Models — диаграммы процессов в нотации BPMN или упрощённые схемы потоков;
  • Data Dictionary — описание сущностей, атрибутов, доменов значений и связей;
  • Requirement Specification — спецификация в форме расширенных пользовательских историй или use-кейсов;
  • Decision Logs — журнал принятых решений с контекстом, альтернативами и ответственными;
  • Risks & Assumptions Register — реестр рисков и допущений с оценкой вероятности и воздействия.

Важно, что Confluence не навязывает жёстких форматов: аналитик может адаптировать структуру и содержание под нужды проекта, сохраняя при этом читаемость и внутреннюю согласованность.


Как внедрять Confluence без хаоса

Одна из частых проблем команд: Confluence есть, но через пару месяцев он превращается в "архив случайных страниц". Причина обычно не в инструменте, а в отсутствии базовых правил ведения базы знаний.

Минимальный рабочий набор правил:

  • одна страница - одна тема, без смешивания "требований + протокола встречи + черновых заметок";
  • в каждой странице есть владелец, дата последнего обновления и связанный артефакт (Jira, ТЗ, схема, PR);
  • черновики и утвержденные документы разделяются по статусам и пространствам;
  • решения фиксируются отдельно от обсуждений (например, через раздел "Решение" или ADR-страницу);
  • любые ключевые документы имеют ссылки на смежные страницы — контекст, требования, интеграции, тестирование.

Если эти правила не заданы, команда тратит время на поиск "актуальной правды", а не на работу по задаче.


Практический шаблон страницы аналитика

Удобно использовать повторяемый каркас страницы, чтобы коллеги быстро ориентировались в материале:

  1. Цель страницы (что решаем и зачем).
  2. Контекст (бизнес-процесс, ограничения, заинтересованные роли).
  3. Требования (функциональные и нефункциональные).
  4. Сценарии и исключения.
  5. Ссылки на задачи в Jira и связанные диаграммы.
  6. Решения и открытые вопросы.
  7. История изменений.

Такой формат хорошо дополняет материалы про состав артефактов в Артефакты аналитической деятельности и процессную дисциплину из Документация в процессах.


Типичные ошибки при ведении Confluence

  • Страница без адресата: текст написан "для всех", в итоге не подходит никому.
  • Сухие перечисления без контекста — есть список пунктов, но нет пояснения "когда, зачем и кем использовать".
  • Нет связности: документ не связан с требованиями, задачами и тестами.
  • Нет жизненного цикла: никто не знает, страница актуальна или устарела.

Простой тест качества — новый участник команды должен за 10-15 минут понять, о чем документ, где его границы и какие действия нужны дальше.