Диаграмма кода

Наконец, вы можете увеличить масштаб каждого компонента, чтобы показать, как он реализован в виде кода; используя диаграммы классов UML, диаграммы взаимосвязей сущностей или что-то подобное.

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

Пример

Область видимости

Отдельный компонент.

Первичные элементы

Элементы кода (например, классы, интерфейсы, объекты, функции, таблицы базы данных и т.д.) внутри компонента в области видимости.

Целевая аудитория

Архитекторы и разработчики программного обеспечения.

Рекомендовано?

Нет, особенно для долговременной документации, поскольку большинство IDE могут генерировать такой уровень детализации по требованию.