diff --git a/README.md b/README.md new file mode 100644 index 0000000..b55cd9c --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Схема OpenSpec `use-case-driven` + +`use-case-driven` — переносимая русскоязычная схема OpenSpec, основанная на +базовой `spec-driven`. Она задаёт формат артефактов change и спецификаций +поведения; подробные правила схемы находятся в +[README схемы](openspec/schemas/use-case-driven/README.md). + +## Чем отличается от `spec-driven` + +- В базовой схеме сценарии оформляются краткими шагами Gherkin `WHEN` / `THEN`. + Здесь используются сценарии использования без Gherkin: полные или + сокращённые, связанные с функциональными требованиями. +- Один `Requirement` описывает завершённую функцию и содержит один `Scenario`. + Подробные правила, устойчивые контракты и обязательные ограничения + фиксируются в локальных `FR`; HTTP-контракт размещается в `CONTRACT`. +- Master-спецификация явно описывает `Purpose`, `Границы` ответственности + capability и полный набор `Requirements`. Delta-спецификации меняют требования + стандартными операциями OpenSpec. +- Инструкции и пояснительный текст ориентированы на русский язык; технические + идентификаторы и синтаксис OpenSpec сохраняются. + +## Статус + +Схема находится в стадии доработки. Описаны ещё не все типы функциональных +требований и форматы контрактов: например, для FR `[UI]` пока нет подробного +паттерна; могут отсутствовать и другие типы. Поэтому схема пока не гарантирует, +что при подготовке спецификации будут выявлены все применимые требования — в +том числе к безопасности, аудиту и ролевой модели. Эти аспекты нужно явно +учитывать при анализе изменения.