Использование Mindmap для написания требований

Меня зовут Татьяна Ошуркова, я разработчик, аналитик и автор телеграм-канала IT Talks. Существует множество подходов и инструментов для работы с требованиями и их описания, в том числе текстовые спецификации, диаграммы и многое другое.

В этой статье я разберу использование простого, понятного, наглядного инструмента, который интегрируется с подходом Docs as code – Mindmap (Интеллект-карта). Этот метод позволяет организовывать требования в виде древовидной структуры, что делает процесс работы более гибким и наглядным.

Структурирование требований

В процессе написания требований важно четко определить их уровни и типы. В шаблонах спецификаций это разделы и подпункты в них. Рассмотрим, что может являться ветвями Mindmap:

• Бизнес-требования – цели проекта, ценность для пользователей и бизнеса. Здесь фиксируются цели проекта и его задачи.

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

• Нефункциональные требования – требования к производительности, безопасности, удобству использования, отказоустойчивости. Можно детализировать их по категориям, например, безопасность – уровни доступа, шифрование данных.

• Ограничения – технологические, правовые, организационные. Например, поддерживаемые платформы, соответствие законодательным нормам, бюджетные ограничения.

• Связи и зависимости – взаимодействие с другими системами, API, интеграции. Полезно включать ссылки на внешние системы, документы API или диаграммы взаимодействий.

Процесс работы с Mindmap

1. Создание центрального узла – задаем название проекта или продукта, краткую аннотацию.

2. Разветвление на основные категории требований – добавляем ключевые ветви, например, бизнес-требования, функциональность, ограничения.

3. Детализация каждого элемента – прорабатываем подуровни, например, для бизнес-требований можно добавить подузлы «цели доработки», «заинтересованные стороны».

4. Использование цветовых кодов, тегов и иконок – помогает быстро ориентироваться в карте. Например, красный цвет для критических ограничений, синий для интеграций.

5. Регулярное обновление Mindmap – если карта построена для документации проекта в целом, то по мере развития она может меняться: добавляются новые требования, меняются приоритеты, появляются новые зависимости. Если карта строится для конкретной доработки, то карта будет обновляться по мере изменения требований.

6. Обсуждение и согласование – Mindmap можно использовать на встречах с заказчиком или командой, демонстрируя актуальную структуру требований.

Практический кейс

Рассмотрим задачу по разработке системы онлайн-бронирования столиков в ресторанах. Система должна позволять пользователям находить рестораны, просматривать доступность столиков, бронировать их и получать подтверждения. Владельцы ресторанов должны иметь возможность управлять бронированием и видеть расписание занятости столов. Определим требования и пошагово построим карту в PlantUML:

Определим центральный узел и добавим основные ветки:

@startmindmap
* Онлайн-бронирование столиков
** Бизнес-требования
** Функциональные требования
** Нефункциональные требования
** Ограничения
** Связи и зависимости
@endmindmap

Далее определим требования в каждой ветке и детализируем карту:

@startmindmap
* Онлайн-бронирование столиков
** Бизнес-требования
*** Онлайн-бронирование
*** Увеличение загрузки ресторанов
*** Удобный интерфейс
*** Поддержка нескольких ресторанов
@endmindmap

@startmindmap
* Онлайн-бронирование столиков
** Функциональные требования
*** Регистрация и авторизация
*** Поиск ресторанов
**** По названию
**** По местоположению
**** По типу кухни
*** Просмотр доступности столиков
*** Бронирование столика
**** Выбор даты и времени
**** Подтверждение бронирования
*** Уведомления
**** Email
**** SMS
*** Управление бронированием
**** Внесение изменений
**** Отмена бронирования
@endmindmap

@startmindmap
* Онлайн-бронирование столиков
** Нефункциональные требования
*** Быстродействие (<2 сек отклик)
*** Доступность (99.9%)
*** Безопасность данных
*** Логирование операций
@endmindmap

@startmindmap
* Онлайн-бронирование столиков
** Ограничения
*** Поддержка веб и мобильных устройств
*** Ограничение по регионам
*** Нет интеграции с платежами
@endmindmap

@startmindmap
* Онлайн-бронирование столиков
** Связи и зависимости
*** Интеграция с картами (Google Maps, OSM)
*** Почтовые уведомления
*** Экспорт бронирований в календари
@endmindmap

Рассмотрим финальную версию карты, совместив все фрагменты:

@startmindmap
* Онлайн-бронирование столиков
** Бизнес-требования
*** Онлайн-бронирование
*** Увеличение загрузки ресторанов
*** Удобный интерфейс
*** Поддержка нескольких ресторанов
** Функциональные требования
*** Регистрация и авторизация
*** Поиск ресторанов
**** По названию
**** По местоположению
**** По типу кухни
*** Просмотр доступности столиков
*** Бронирование столика
**** Выбор даты и времени
**** Подтверждение бронирования
*** Уведомления
**** Email
**** SMS
*** Управление бронированием
**** Внесение изменений
**** Отмена бронирования
** Нефункциональные требования
*** Быстродействие (<2 сек отклик)
*** Доступность (99.9%)
*** Безопасность данных
*** Логирование операций
** Ограничения
*** Поддержка веб и мобильных устройств
*** Ограничение по регионам
*** Нет интеграции с платежами
** Связи и зависимости
*** Интеграция с картами (Google Maps, OSM)
*** Почтовые уведомления
*** Экспорт бронирований в календари
@endmindmap

Связь Mindmap с другими артефактами

Mindmap можно использовать вместе с различными артефактами для работы с требованиями, дополняя их и упрощая анализ. UML-диаграммы помогают детализировать отдельные аспекты системы, такие как сценарии использования, классы и взаимодействия. BPMN-диаграммы позволяют уточнить бизнес-процессы, которые сначала можно структурировать в виде Mindmap. Документы требований (SRS, Vision, BRD) могут строиться на основе Mindmap, где выделены основные категории требований. В табличных форматах (Excel, Jira, Confluence) Mindmap помогает определить структуру и взаимосвязи требований перед их переносом в систему управления. В API-документации Mindmap может использоваться для предварительной организации методов и их параметров, что упрощает работу с интеграциями. Такой подход делает процесс работы с требованиями более наглядным, организованным и понятным.

Инструменты для работы с Mindmap

Рассмотрим инструменты для работы с Mindmap, их преимущества и примеры построения.

XMind – удобный инструмент с множеством функций в бесплатном режиме. Есть экспорт и импорт в различных форматах. Поддерживает режим совместной работы. Приятный внешний вид, понятный интерфейс.

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

MindMeister – инструмент, схожий с упомянутыми выше. Менее удобный, а также предоставляет очень ограниченный функционал в бесплатной версии.

Подведем итоги

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

В завершение делюсь литературой по построению интеллект-карты:

• Интеллект-карты. Полное руководство по мощному инструменту мышления. Тони Бьюзен

• Интеллект карты (mindmap). Графическое решение бизнес-задач. Рязанцев Алексей Владимирович

• Интеллект-карты от А до Я. Кирилина Рената, Кирилин Сергей

• Mind Mapping: Improve Memory, Concentration, Communication, Organization, Creativity, and Time Management. Kam Knight

• Mind Map Mastery: The Complete Guide to Learning and Using the Most Powerful Thinking Tool in the Universe. Tony Buzan

• How to Mind Map. 7 Easy Steps to Master Mind Mapping Techniques, Note-taking, Creative Thinking & Brainstorming Skills. Troye Bates