docs: onboarding methodology — principles, checklist, enduro reference (ORCH-9)
This commit is contained in:
35
examples/enduro-trails/README.md
Normal file
35
examples/enduro-trails/README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Пример-референс: enduro-trails
|
||||
|
||||
**enduro-trails** — первый проект, обкатанный под оркестратором в бою. Его репо — живой образец канона.
|
||||
Используй как **референс структуры и тона**, НЕ копируй содержимое (оно специфично для enduro: карты/terrain/OSRM).
|
||||
|
||||
> Файлы здесь НЕ дублируются — это указатели на эталонный репо, чтобы он оставался единственным источником и не расходился с копией.
|
||||
|
||||
## Что смотреть в эталонном репо enduro-trails
|
||||
|
||||
### Паспорт проекта
|
||||
- `CLAUDE.md` — образец паспорта: TL;DR, стек, команды, среды, конвенции, правила для агентов.
|
||||
|
||||
### Документация
|
||||
- `docs/architecture/README.md` + `docs/architecture/adr/` — обзор архитектуры + сквозные ADR.
|
||||
- `docs/work-items/<ET-NNN>/` — реальные артефакты задач: `00-business-request.md`, `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml`, `06-adr/ADR-NNN-slug.md`, `12-review.md`, `13-test-report.md`, `14-deploy-log.md`.
|
||||
- `docs/phases/PH-N.*/` — фазовая разбивка (опционально, не каждый проект).
|
||||
|
||||
### Промпты агентов (★ эталон каркаса)
|
||||
- `.openclaw/agents/architect.md` — образцовый каркас промпта:
|
||||
`frontmatter (name/description/model/tools) → "Кто ты" → "Контекст проекта" → "Что прочесть в начале" → "Что произвести" → "Принципы" → "Запрещено" → "Эскалация"`.
|
||||
- `.openclaw/agents/{analyst,developer,reviewer,tester,deployer}.md` — остальные роли.
|
||||
- Обрати внимание: доменная специфика (MapLibre/OSRM/terrain, «всё в Docker», «vanilla JS > React») зашита в «Принципы» и «Запрещено» — **именно это меняешь под свой проект**.
|
||||
|
||||
## Как использовать
|
||||
1. Открой `architect.md` enduro → пойми каркас.
|
||||
2. Скопируй СТРУКТУРУ разделов в свой `.openclaw/agents/architect.md`.
|
||||
3. Замени ВСЁ доменное содержимое на специфику своего проекта.
|
||||
4. Повтори для 6 ролей.
|
||||
5. Сверься с `../../principles/PROMPT_PRINCIPLES.md` (инварианты канона + чеклист).
|
||||
|
||||
## ⚠️ Антипаттерн
|
||||
Скопировать enduro-промпт целиком и оставить «MapLibre/OSRM/terrain» в проекте, который к картам отношения не имеет. Каркас — да, содержимое — своё.
|
||||
|
||||
---
|
||||
*Эталонный репо: enduro-trails (в той же Gitea-инстанции). Здесь только указатели — не копии.*
|
||||
Reference in New Issue
Block a user