docs: add v0.1 lane specs

This commit is contained in:
Codex
2026-05-29 08:59:54 +08:00
parent 7be1d9b6c3
commit 8b09ecd7e4
5 changed files with 293 additions and 8 deletions
@@ -0,0 +1,55 @@
# v0.1 文档治理规格
本文是 AgentRun `v0.1` 文档体系的长期规格。它定义仓库入口、长期规格位置、计划和过程材料的承载方式,以及旧 `dev/prod` 口径迁移规则。
## 设计目标
- `AGENTS.md` 是 agent、指挥官和 runner 进入 AgentRun 仓库的唯一顶级入口。
- `docs/reference/spec-v01-*.md``v0.1` 微服务、CI/CD、CLI、运行面和系统能力的权威规格。
- `docs/reference/` 只保存长期稳定、可复用的规格、边界、入口、判定标准和稳定 runbook。
- 计划、阶段拆解、一次性排障、临时报告和执行证据进入 GitHub issue 或 PR 评论,不直接沉淀为仓库长期文档。
- `docs/` 根目录不得堆放 Markdown 报告或 JSON dump;机器可消费契约应放入未来的 `protocol/``deploy/` 或源码相邻目录,临时输出放 `/tmp``.state` 或 CI artifact。
-`dev/prod` 管理说法不再作为当前规格;AgentRun 从 `v0.1` 开始按 `v0.1``v0.2``v0.3` 版本 lane 滚动。
## 允许的文档形态
| 位置 | 允许内容 | 不允许内容 |
| --- | --- | --- |
| `AGENTS.md` | 顶级入口、一句话 P0 规则、长期参考链接 | 详细设计、阶段计划全文、临时结论、过程流水账 |
| `docs/reference/*.md` | 长期规格、稳定边界、判定标准、可复用 runbook | 日期化报告、一次性排障全文、临时 evidence、旧规格副本 |
| `docs/reference/spec-v01-*.md` | `v0.1` 当前权威规格 | 与 `v0.1` 无关的 `v0.2+` 计划全文、未蒸馏过程材料 |
| GitHub issue/PR | 计划、里程碑、过程记录、执行证据、实现任务 | 替代 `docs/reference` 成为长期唯一权威 |
| `/tmp` / `.state` / CI artifact | 临时输出、trace、日志、报告、截图 | 需要长期复用的规格或入口 |
## Spec 命名规则
- `spec-v01-documentation-governance.md`:文档治理和旧口径迁移。
- `spec-v01-services.md`:服务总览、保留和 deferred 对象。
- `spec-v01-cicd.md`:版本 lane、GitOps、namespace、registry 和发布验收。
- 未来新增单服务规格必须使用 `spec-v01-<service-or-capability>.md`,例如 `spec-v01-agentrun-mgr.md``spec-v01-agentrun-runner.md`
- `v0.2` 或更高版本的规格不得写入 `spec-v01-*`;只能在对应版本 lane 中创建自己的 `spec-v02-*``spec-v03-*`
## 迁移规则
1. 发现 `README.md``docs/*.md``docs/*.json` 或计划文档时,先判断是否有长期价值。
2. 有长期价值的,只把稳定结论吸收到对应 `docs/reference/spec-v01-*.md`;不要整篇搬入 reference。
3. 属于计划、里程碑、阶段迁移、报告、一次性排障或历史验收的,全文迁入 GitHub issue 或 PR 评论,再删除源文件。
4.`v0.1` 规格冲突的旧 `dev/prod``/root/agentrun` 默认工作区、`agentrun_dev``agentrun_prod` 说法必须删除或改为历史背景。
5. 未实现规格必须在对应 spec 的“规格的实现情况”中明确写成 `未实现``未完全实现`,不要用散落 TODO 代替。
## v0.1 当前权威入口
- Source branch`v0.1`
- Source workspace`G14:/root/agentrun-v01`
- Worktree 根:`G14:/root/agentrun-v01/.worktree/{task}`
- Runtime namespace`agentrun-v01`
- 发布和验收规格:[spec-v01-cicd.md](spec-v01-cicd.md)。
- 服务总览规格:[spec-v01-services.md](spec-v01-services.md)。
## 验收标准
- `AGENTS.md` 索引本文和其他 `spec-v01-*` 规格。
- `docs/reference/` 中存在 `spec-v01-documentation-governance.md``spec-v01-services.md``spec-v01-cicd.md`
- `AGENTS.md``docs/reference/` 不得把旧 `agentrun_dev``agentrun_prod``G14:/root/agentrun``/root/agentrun` 写成当前工作区、namespace、发布目标或验收目标;只允许在废弃说明和历史背景中提及。
- `docs/` 根目录不新增临时 Markdown 报告或 JSON dump。
- 后续实现任务先更新或引用对应 `spec-v01-*`,再修改代码和测试。