Чеклист для проверки архитектурных диаграмм

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

Несколько правил для проверки своей архитектурной диаграммы.

Общие вопросы которые стоит себе задать

1. У диаграммы есть заголовок?
2. Понятно, к какому типу относится диаграмма, что она показывает?
3. Понятен ли уровень и скоуп диаграммы?
4. У диаграммы есть легенда / расшифровка обозначений?

Как проверить элементы диаграммы

1. У каждого элемента есть название?
2. Понятен ли тип каждого элемент (уровень абстракции)?
3. Понятно, что делает каждый элемент?
4. Понятна ли технология, связанная с элементом? (если применимо на данном уровне абстракции)
5. Понятен ли смысл всех аббревиатур и сокращений?
6. Понятен ли смысл всех цветов элементов?
7. Понятен ли смысл всех форм элементов?
8. Понятен ли смысл всех иконок?
9. Понятен ли смысл линий границ элементов? (сплошная, пунктирная…)
10. Понятен ли смысл размеров элементов?
11. Понятен ли смысл группировки элементов?

Связи и отношения

1. У каждой лини есть подпись, объясняющая смысл связи?
2. Для каждой связи понятна технология, при помощи которой эта связь реализуется? (например, протокол; если применимо на данном уровне абстракции)
3. Понятен ли смысл всех аббревиатур и сокращений на диаграмме?
4. Понятен ли смысл всех цветов элементов?
5. Понятен ли смысл всех типов стрелок?
6. Понятен ли смысл всех типов линий? (сплошная, пунктирная…)