Джина Гайд

Структура комплекта требований

Комплект включает инструкцию и два самостоятельных репозитория. Подробные справочники: структура шаблона и структура системы «Обратная связь — регион».

Папка или артефакт Назначение
template/ Самостоятельный стартовый репозиторий с draft-заготовками feature1/feature2, инструментами и методической инструкцией. Содержимое копируется в новый проект и заполняется по предметному смыслу.
example/ Самостоятельный репозиторий требований системы «Обратная связь — регион». Содержит HLR, REQ, архитектуру, приёмочный план, данные и разбор изменения.
README.md Точка входа в комплект: порядок изучения инструкции, шаблона и заполненного репозитория. Содержит ссылки на основные документы и команды запуска.
STRUCTURE.md Карта самого комплекта и ссылки на справочники двух самостоятельных репозиториев. Подробные назначения вложенных папок и артефактов находятся в этих справочниках.
VALIDATION.md Отчёт о фактически выполненной проверке комплекта с результатами и границами проверки. Отделяет проверку требований и инструментов от продуктовой приёмки.
validation-results.json Машиночитаемые результаты той же проверки с датой, составом и выводом каждого запуска. Используется для проверки и обработки отчёта программой.
GUIDE.md Основная инструкция: качество требований, состав комплекта, два уровня детализации, процесс изменения и приёмка. Содержит чек-лист применимости и порядок наполнения пакетов HLR.
FORMAT.md Канонические источники, выбранные контрольные поля и смысл связей между артефактами. Объясняет, какую часть Markdown проверяет скрипт и какую оценивает ревьюер.
TOOLS.md Команды проверки, условия готовности, формирование отчётов и ограничения автоматизации. Помогает запускать необходимые проверки и правильно читать результат.
ARCHITECTURE.md Место архитектуры относительно HLR/REQ, вопросы представлений и распределение источников истины. Объясняет переход от проектного решения к обязательству разработки.
ARTIFACTS.md Обоснование формы каждого артефакта и выбора автоматизации. Фиксирует, где достаточно Markdown и агентского ревью, а где нужен машинный формат или вычисляемый отчёт.