diff --git a/README.md b/README.md index f420c88..4b36aa0 100644 --- a/README.md +++ b/README.md @@ -35,21 +35,7 @@ Use it when a project has one or more of these symptoms: - **A self-growing knowledge base** — delivery leaves behind decisions, requirements, scenarios, and evidence that future work can reuse. - **A portable starting point** — an agent brings the template into a repository and adapts it from the project's own evidence. -```text -Project knowledge + DNA - ↓ - Issue / task - ↓ - Task Routing - ↓ - Delivery Flow - ↓ -Brief → Design Pack → Implementation Plan - ↓ - Code → verification → PR - ↓ -Decisions, evidence, and new knowledge return to Memory Bank -``` +![Running a task through Memory Bank routing](docs/assets/quick-start-routing-en.gif) The result is a feedback loop: project knowledge guides delivery, and delivery improves project knowledge. @@ -108,6 +94,10 @@ The `flows/` layer describes repeatable processes that an agent can follow. Ever For a substantial feature, Feature Flow produces a Feature Pack in three stages: +The flow treats the feature as a testable vertical slice and follows +specification-driven development: the documents required by the selected route +are created and reviewed before implementation begins. + ```text brief.md design.md implementation-plan.md what and why → chosen solution → implementation and checks diff --git a/README.ru.md b/README.ru.md index 2d01670..3245989 100644 --- a/README.ru.md +++ b/README.ru.md @@ -35,21 +35,7 @@ Memory Bank полезен, если в проекте встречается х - **Самонаполняющуюся базу знаний** — после разработки остаются решения, требования, сценарии и подтверждения, которыми воспользуются следующие задачи. - **Переносимую точку старта** — агент устанавливает шаблон в репозиторий и адаптирует его по фактам самого проекта. -```text -Знания о проекте + ДНК - ↓ - Задача - ↓ - Маршрутизация - ↓ - Процесс разработки - ↓ -Бриф → Дизайн-пакет → План реализации - ↓ - Код → проверки → запрос на слияние - ↓ -Решения, подтверждения и новые знания возвращаются в Memory Bank -``` +![Запуск задачи через маршрутизацию Memory Bank](docs/assets/quick-start-routing.gif) Так возникает замкнутый цикл: знания проекта направляют разработку, а результаты разработки улучшают знания проекта. @@ -109,6 +95,11 @@ https://github.com/dapi/memory-bank/blob/main/docs/brownfield-adaptation-protoco Для значимого функционального изменения процесс Feature Flow создаёт Feature Pack — комплект документов фичи, который проходит три стадии: +Процесс рассматривает функциональное изменение как проверяемый вертикальный +срез и следует разработке на основе спецификации: предусмотренные +выбранным маршрутом документы создаются и проходят проверку до начала +реализации. + ```text brief.md design.md implementation-plan.md что и зачем → выбранное решение → реализация и проверки diff --git a/docs/assets/quick-start-feature-pack.gif b/docs/assets/quick-start-feature-pack.gif index 71d90c2..9ae6175 100644 Binary files a/docs/assets/quick-start-feature-pack.gif and b/docs/assets/quick-start-feature-pack.gif differ diff --git a/docs/assets/quick-start-routing-en.gif b/docs/assets/quick-start-routing-en.gif new file mode 100644 index 0000000..f3cb2bd Binary files /dev/null and b/docs/assets/quick-start-routing-en.gif differ diff --git a/docs/assets/quick-start-routing.gif b/docs/assets/quick-start-routing.gif index f5720e5..e534eee 100644 Binary files a/docs/assets/quick-start-routing.gif and b/docs/assets/quick-start-routing.gif differ diff --git a/docs/assets/quick-start-start-issue.gif b/docs/assets/quick-start-start-issue.gif index c65cb8c..b2a1682 100644 Binary files a/docs/assets/quick-start-start-issue.gif and b/docs/assets/quick-start-start-issue.gif differ diff --git a/docs/quick-start.md b/docs/quick-start.md index b3d3d45..1917127 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -57,16 +57,17 @@ memory-bank-cli doctor ## 3. Выбрать сценарий запуска -Используйте один из трёх сценариев. GIF показывают сокращённый ввод в терминале, -а команды под ними можно копировать. Ответы агента будут зависеть от задачи и +Используйте один из трёх сценариев. GIF показывают сокращённое +взаимодействие в терминале, а команды под ними можно копировать. Ответы агента +будут зависеть от задачи и текущего состояния проекта. ### Вариант 1. Доверить выбор процесса Memory Bank ![Запуск задачи через маршрутизацию Memory Bank](assets/quick-start-routing.gif) -Это основной сценарий. Memory Bank сам определит подходящий процесс и создаст -только необходимые документы. +Это основной сценарий. Агент выполнит маршрутизацию Memory Bank, выберет +подходящий процесс и создаст только необходимые документы. ```bash codex -C . \ diff --git a/docs/usage.md b/docs/usage.md index 51c2af2..7b516b2 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -108,6 +108,10 @@ Memory Bank добавляет управляемый цикл: Для значимой фичи процесс создаёт Feature Pack — долговременный комплект документов изменения: +Feature Flow рассматривает такую фичу как проверяемый вертикальный срез и +следует разработке на основе спецификации: предусмотренные выбранным маршрутом +документы создаются и проверяются до начала реализации. + ```text brief.md design.md implementation-plan.md что и зачем → выбранное решение → реализация и проверки