A comment containing a description of an element in the architecture.
Определение метаданных архитектуры ArchitectureMetadataDefinition
На какой вопрос отвечает «Как описать этот элемент архитектуры текстом?»,
Это текстовый комментарий, который описывает конкретный элемент архитектуры. Он служит пояснением к объекту модели, фиксируя его суть в виде простого текста.
Аналогия Как подпись под фотографией в альбоме, которая объясняет, кто или что изображено на снимке.
Разобраться
Зачем это нужно
Нужно, чтобы участники проекта понимали назначение элементов без изучения исходного кода или сложных схем. Это упрощает коммуникацию между архитекторами и разработчиками.
Применить
Когда это нужно, а когда нет
Когда нужно
- Нужно зафиксировать описание компонента в модели
- Требуется пояснить назначение узла или сервиса
- Создаётся документация к элементам метамодели
Когда не нужно
- Нужно описать состояние ресурса — используйте специализированные классы состояний
- Требуется определить связь между объектами — используйте связи типа «Определяет»
- Описывается организационная структура — используйте классы «Организация» или «Организационный ресурс»
Типичные ошибки
- 01Путать описание элемента с описанием его динамических состояний
- 02Использовать этот класс для хранения технических параметров вместо текстового пояснения
- 03Пропускать этот элемент, полагая, что название объекта само по себе достаточно понятно
Сверить с первоисточниками
Что говорят стандарты
Определения из источников с переводом и ссылкой на раздел. Категория показывает назначение каждого подхода.
С чем связано
Связи понятия и его место в структуре подхода.
Управление архитектурой (Architecture Management)
- Обобщение — таксономическое отношение «частное → общее»MeasurableElement
Связанные понятия
Понятия, которые обычно смотрят рядом с этим.
Опишите архитектуру своей компании в Storm
Реестр процессов, архитектурное рабочее пространство, связи между системами и процессами — те самые артефакты, только про вашу организацию.
Это же в StormАрхитектура систем и интеграцийГраф связей реестраРеестр процессов