Модуль «Документирование»
Правила работы с артефактами и каталогами, пользовательская документация и инструменты (PlantUML) в модельно-ориентированном подходе.
В AI SDLC ПО и документация создаются на базе формализованных моделей. Каждая часть модели, каталог или артефакт (требования, код, тест-кейсы) - это документ, который создаётся, проверяется, дорабатывается и выкладывается в строго определённое место. Документов много, поэтому нужны чёткие правила работы с ними.
Управление каталогами
- Вариантов использования
- Сущностей предметной сферы
- Объектов конфигурации
- Интеграций (API)
- Классов, методов, процедур и функций
- Сущностей базы данных
- Тест-кейсов
Состав модуля
- 1Управление каталогами хранения артефактов
- 2Управление изменением отдельных артефактов
- 3Создание пользовательской документации
- 4Инструмент для создания диаграмм PlantUML
Документы создаются из моделей и поддерживаются в актуальном состоянии: любое изменение в коде или требованиях отражается в документации. Поддерживаются форматы Markdown, Confluence, PDF, Swagger/OpenAPI, а также реинжиниринг код ↔ документация.
Формализованные модели создают контекст (каталоги артефактов) для внесения изменений в объёмных комплексных проектах и обеспечивают трассируемость и целостность.
Оставьте заявку, подберём набор модулей под ваш проект.