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

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

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

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

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

  • У каждого элемента есть название?
  • Понятен ли тип каждого элемент (уровень абстракции)?
  • Понятно, что делает каждый элемент?
  • Понятна ли технология, связанная с элементом? (если применимо на данном уровне абстракции)
  • Понятен ли смысл всех аббревиатур и сокращений?
  • Понятен ли смысл всех цветов элементов?
  • Понятен ли смысл всех форм элементов?
  • Понятен ли смысл всех иконок?
  • Понятен ли смысл линий границ элементов? (сплошная, пунктирная…)
  • Понятен ли смысл размеров элементов?
  • Понятен ли смысл группировки элементов?

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

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