Что вы включаете в архитектурную спецификацию?

Что вы включаете в архитектурную спецификацию?
Что вы включаете в архитектурную спецификацию? - sigmund @ Unsplash

В настоящее время я пересматриваю ряд шаблонов документов для своей компании. У нас никогда не было формальной архитектурной спецификации, поэтому я начинаю ее составлять.

Какие вещи вы включаете в свои архитектурные спецификации? Не стесняйтесь копировать и вставлять оглавление - это было бы полезно. Есть ли какие-нибудь хорошие шаблоны, уже доступные в Интернете?

Я смоделировал свои документы архитектуры программного обеспечения (или SADs, что является двойным смыслом, поскольку это и аббревиатура, и то, что чувствуют разработчики, глядя на них) - после документа Rational Unified Process Software Architecture .

Он предоставляет хороший шаблон для объяснения архитектуры высокого уровня и некоторые указатели / описания того, что куда должно идти. На самом деле, я нашел весь набор шаблонов RUP бесценным при правильном использовании (не бойтесь редактировать документы и моделировать их на основе информации, которую вы считаете полезной.

Кроме этого - высокоуровневая UML-диаграмма общих компонентов/пакетов системы. Затем важные подкомпоненты (диаграммы классов), и, если они достаточно сложны, некоторые диаграммы последовательности, описывающие важные взаимодействия между компонентами.

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


LetsCodeIt, 28 мая 2023 г., 21:45