Репозиторий требований: инструкция, шаблон и пример
Структура папок и назначение артефактов.
С чего начать
- Прочитать инструкцию: качество требований, два уровня детализации, состав пакета, процесс работы и приёмка.
- Изучить учебный пример, начиная с обзора и верхнеуровневых требований.
- Прочитать формат метаданных и связей и инструменты.
- Скопировать содержимое template/ в новый репозиторий. Шаблоны разделов лежат в template/templates/.
- Заполнить первый вертикальный срез: верхнеуровневая возможность → правила спецификации → сценарии с отдельными проверками → данные → анализ влияния изменения.
Что находится здесь
| Путь | Назначение |
|---|---|
| GUIDE.md | Основная инструкция и полный чек-лист применимости |
| ARCHITECTURE.md | Место архитектуры, шесть представлений, канонические источники и технические обязательства |
| ARTIFACTS.md | Выбор формы каждого артефакта и основание автоматизации |
| FORMAT.md | Канонические источники, форматы, кратность и смысл связей |
| TOOLS.md | Команды, реализованные проверки, ограничения и подключение CI |
| template/ | Самостоятельный стартовый репозиторий, шаблоны, схемы и инструменты |
| example/ | Самостоятельный заполненный репозиторий требований системы обратной связи |
| VALIDATION.md | Фактически выполненная проверка комплекта |
Учебный пример описывает вымышленную систему «Обратная связь — регион». Система предназначена для приёма жалоб жителей, предварительной обработки и направления обращений в ответственные ведомства. Она собирает ответы ведомств, доставляет итог заявителю и предоставляет аналитику по результатам обработки.
Быстрый запуск примера
Python 3.11+; команды выполняются из example/:
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements-tools.txt
.\.venv\Scripts\python.exe scripts/reqtool.py lint --ready
.\.venv\Scripts\python.exe scripts/reqtool.py generate
.\.venv\Scripts\python.exe -m unittest discover -s scripts/tests -v
lint --ready проверяет готовность спецификаций к реализации по формальным правилам. Проверка требований не является приёмкой работающего продукта. В примере нет результатов продуктовых тестов: покрытие обозначает запланированные проверки.
Архитектура: инструкция и проект в примере. Обязательные технические ограничения входят в тот же уровень REQ и тот же план приёмки.
Вопросы, решения, протяжка и архитектура редактируются непосредственно в Markdown. Generated содержит два необязательных вычисляемых отчёта. Выбор форматов и проверок объясняет, где достаточно агентского ревью и где оправдана автоматизация.