Существует несколько общепринятых подходов к такому описанию, каждый со своей спецификой и ценностью. О них рассказываем в этой статье. А еще показываем, как выглядит документ «Архитектурное описание», который мы используем на нашей программе «Архитектор ПО». Документ очень функционален, и после работы с ним на программе вы сможете использовать его и в своей ежедневной работе.
Подходы к документированию архитектурных решений
Architecture Decision Records (ADR)
Architecture Decision Records (ADR) — это краткие документы, которые фиксируют одно важное архитектурное решение, его контекст, рассмотренные альтернативы, обоснование выбора и последствия.
Преимущества и использование: ADR обеспечивает прозрачность процесса принятия решений, а также сохраняет историю выбора, что отвечает на вопрос «почему так?». Это предотвращает повторные обсуждения и позволяет команде легко вернуться к предыдущим решениям. Основное преимущество ADR заключается в том, что они фокусируются строго на самих решениях, а не на текущем состоянии системы. Такие документы часто хранятся вместе с кодом, что упрощает доступ к ним.
Модель C4
Модель C4 предлагает иерархический подход к визуализации архитектуры через четыре уровня:Преимущества и использование: Ценность Модели C4 заключается в её наглядности и простоте восприятия, как для технических, так и для нетехнических специалистов. Она идеально подходит для быстрого понимания общей картины архитектуры и эффективной коммуникации между участниками разработки.
Основной акцент модели C4 делается на диаграммах, что облегчает визуализацию и обсуждение архитектурных решений.
Кстати, в нашей программе «Архитектор ПО» вы будете работать с ADR и C4 в курсе «Документирование архитектурных решений».
Подход «Views and Beyond» (Филипп Кручтен)
Подход «Views and Beyond» основан на представлениях (Views), которые описывают архитектуру с различных точек зрения: логическая, процессная и развертывания. Каждое представление предназначено для определенной аудитории и фокусируется на ключевых аспектах архитектуры.Преимущества и применения: Этот подход обеспечивает полноту и структурированность архитектурной информации, что особенно полезно для сложных проектов. Он охватывает все аспекты системы, обеспечивая всестороннее понимание. Однако такой подход требует значительных усилий для поддержания актуальности информации, поскольку он высоко формализован.
Комплексные шаблоны (например, arc42)
Шаблоны, такие как arc42, представляют собой заранее подготовленные и хорошо продуманные структуры, которые задают формат документации. Они включают различные разделы, такие как цели, ограничения, решения, риски и требования.Преимущества и использование: Ценность таких шаблонов заключается в их способности обеспечивать полноту охвата ключевых аспектов архитектуры и ускорять процесс создания документации, предлагая уже готовую структуру. Шаблоны широко используются как стандарты в индустрии, что делает их важным инструментом для эффективного документирования архитектурных решений.
Ценность таких шаблонов заключается в том, что они обеспечивают полноту охвата ключевых аспектов архитектуры и ускоряют процесс создания документации, предлагая готовую структуру. Шаблоны широко используются как стандарты в индустрии. На нашей программе студенты работают с реальными архитектурными описаниями, что помогает им сразу освоить шаблон для будущих проектов.
Вы можете бесплатно скачать часть архитектурного шаблона, с которым работают участники нашей программы «Архитектор ПО». Полную версию вы получите в качестве рабочей тетради, обучаясь на программе.
Статья подготовлена методическим отделом Учебного Центра IBS.