C4 чеклист ревью архитектурных диаграмм

2019-11-29 14:51:12 +0600 +0600

C4 чеклист ревью архитектурных диаграмм

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

GENERAL

• Есть ли тайтл у диаграммы ?

• Понятен ли какой тип диаграммы (компонент , деплоймент, контейнер ….)?

• Понятна ли область действия диаграммы ?

• Есть ли легенда ?

Элементы

• Есть ли у всех элементов имена ?

• Понятен ли тип каждого элемента ?

• Понятно ли что делает каждый элемент ?

• Понятны ли технологии связанные с элементом ?

• Понятны ли аббревиатуры и мнемоники элементов ?

• Если на диаграмме разные цвета понятны ли они ?

• Если в диаграмме разные фигуры используются понятны ли их назначения ?

• Если в диаграмме разные иконки используются понятны ли их назначения ?

• Если есть элементы в рамках понятны ли назначения рамок ?

Отношения

• Есть ли у стрелок подписи ?

• Понятны ли технологии и протоколы у стрелок ?

• Понятны ли сокращения и мнемоники на стрелках ?

• Понятны ли назначения цветов на разноцветных стрелках ?