Post #424

Перевел для вас чеклист по диаграммам от автора C4 model. В принципе, ничего необычного, всё понятно. Как всегда, из всего чеклиста не срабатывает обычно 1-2 пункта, но они как раз могут всё испортить. Я вот про себя отметил, что я точно слишком вольно отношусь к размерам элементов, и часто без объяснений делаю их разными. И группировку элементов не всегда объясняю. И иногда оставляю связи без подписей, что уж тут. В общем, даже если вы рисуете неформальные диаграммы из квадратиков и стрелочек, это не означает, что в них не должно быть семантики и могут быть пропуски. Ничего нет хуже фотки доски полугодовой давности, на которой часть стрелок зелёная, а часть синяя, и уже никто не помнит, что это означало... Вопросы чеклиста: Общие У диаграммы есть заголовок? Понятно, к какому типу относится диаграмма, что она показывает? Понятен ли уровень и скоуп диаграммы? У диаграммы есть легенда / расшифровка обозначений? Элементы У каждого элемента есть название? Понятен ли тип каждого элемента (уровень абстракции)? Понятно, что делает каждый элемент? Понятна ли технология, связанная с элементом? (если применимо на данном уровне абстракции) Понятен ли смысл всех аббревиатур и сокращений? Понятен ли смысл всех цветов элементов? Понятен ли смысл всех форм элементов? Понятен ли смысл всех иконок? Понятен ли смысл линий границ элементов? (сплошная, пунктирная…) Понятен ли смысл размеров элементов? Понятен ли смысл группировки элементов? Связи и отношения У каждой лини есть подпись, объясняющая смысл связи? Для каждой связи понятна технология, при помощи которой эта связь реализуется? (например, протокол; если применимо на данном уровне абстракции) Понятен ли смысл всех аббревиатур и сокращений на диаграмме? Понятен ли смысл всех цветов элементов? Понятен ли смысл всех типов стрелок? Понятен ли смысл всех типов линий? (сплошная, пунктирная…) Их же прилагаю в виде файла, пользуйтесь!