Разделы документации

Основные понятия

Разберитесь, как в Reqode устроены проекты и ветки, где хранятся требования и как они связаны со спецификациями.

Проект и ветка

В проекте хранится модель одного продукта. Проверьте название проекта и ветку в его шапке. Новый проект открывается в основной ветке Main Branch. В отдельной ветке можно согласовать изменения модели перед объединением с основной.

Подсистема и модуль требований

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

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

Требования и спецификации

Требование описывает ожидаемое поведение и критерии его проверки. У требования есть ключ, по которому его можно найти. Блок Specifications показывает связанные артефакты.

АртефактЧто описывает
Сущность данныхПредметный объект или набор значений, при необходимости с атрибутами и связями.
Пользовательский интерфейсЭкран или компонент, его поведение и связанные макеты.
Операция APIКонтракт взаимодействия между вызывающей стороной и подсистемой.

Ключ сохраняется при изменении спецификации. Редакция фиксирует её состояние в определённый момент. Для сравнения или обсуждения указывайте также ветку и номер редакции.

Реализация и проверка

Юнит связывает часть реализации с её файлами, зависимостями и спецификациями. Тип юнита задаёт правила для кода с определённой ролью, например для компонента или контроллера.

Тест-кейс задаёт условия, шаги и ожидаемый результат проверки. Фактический результат относится к конкретной попытке выполнения теста.

Связаться с нами

Поля, отмеченные *, обязательны для заполнения.

0 / 5 000

Можно также написать на info@reqode.com