weichen
fed87ad14b
Consolidate approved policies and add local lease, document CAS, commit, candidate and environment gates. Preserve conservative recovery and cleanup limits.
74 lines
3.4 KiB
Markdown
74 lines
3.4 KiB
Markdown
# 项目文档总地图
|
|
|
|
> Agent 协作纪律见仓库根 [AGENTS.md](../AGENTS.md)。
|
|
> 当前焦点见 [ops/CURRENT.md](ops/CURRENT.md)。
|
|
|
|
---
|
|
|
|
## 文档 taxonomy（禁止随意新建路径）
|
|
|
|
```text
|
|
.doc/
|
|
README.md ← 本文件（总地图）
|
|
status/ ← 模块/功能完成度 SSOT
|
|
audit/ ← 问题发现与分析
|
|
remediation/ ← 整改方案与发布缺口
|
|
archive/ ← 历史（只增不删）
|
|
ops/ ← 活协作（任务、交接、调研）
|
|
system-design/ ← 模块架构深读
|
|
adr/ ← 架构决策
|
|
backlog/ ← 产品 backlog（非阻塞）
|
|
test-reports/ ← 验收报告（+ assets/ 附件）
|
|
test-fixtures/ ← 测试拓扑说明
|
|
|
|
仓库根（入口，非内容库）
|
|
AGENTS.md | PROJECT.md | CLAUDE.md | CODEX.md | GEMINI.md | ANTIGRAVITY.md | KIMI.md
|
|
```
|
|
|
|
**红线**：不得在 `.doc/` 根目录新建大包 Markdown；不得在 `docs/` 随意新建子目录。新文档必须落入上表之一。
|
|
|
|
---
|
|
|
|
## 快速入口
|
|
|
|
| 我要… | 读这里 |
|
|
|--------|--------|
|
|
| 规则来源/生效版本 | [规范登记](ops/2026-09-21-policy-registry.md) |
|
|
| 选择测试/报告范围 | [验证契约](ops/2026-09-21-validation-contract.md) |
|
|
| 任务模板与会话收口 | [任务模板](ops/templates/short-term-task.md) · [收口清单](ops/templates/session-close-checklist.md) |
|
|
| 创建任务、集成、部署、清理 | [worktree 工作规范](ops/2026-09-21-agent-worktree-workflow.md) |
|
|
| 当前在做什么 | [ops/CURRENT.md](ops/CURRENT.md) |
|
|
| 模块完成度 | [status/FEATURE-MATRIX.md](status/FEATURE-MATRIX.md) |
|
|
| 发布 blocker | [remediation/gap-matrix.md](remediation/gap-matrix.md) |
|
|
| 审计/问题分析 | [audit/INDEX.md](audit/INDEX.md) |
|
|
| 整改方案 | [remediation/INDEX.md](remediation/INDEX.md) |
|
|
| 历史归档 | [archive/README.md](archive/README.md) |
|
|
| 架构设计 | [system-design/README.md](system-design/README.md) |
|
|
| 测试报告 | [test-reports/](test-reports/) |
|
|
| 历史功能设计 | [archive/design/superpowers/](archive/design/superpowers/) |
|
|
| Herdr 角色、审批与备援 | [ops/2026-09-13-herdr-agent-roster.md](ops/2026-09-13-herdr-agent-roster.md) |
|
|
|
|
---
|
|
|
|
## backlog 分工
|
|
|
|
| 路径 | 用途 |
|
|
|------|------|
|
|
| `backlog/` | 产品侧非阻塞 backlog |
|
|
| `ops/long-term/` | Agent/工程技术债 backlog |
|
|
|
|
---
|
|
|
|
## 文档生命周期
|
|
|
|
按 [AGENTS 任务分级](../AGENTS.md#2-任务分级与授权) 选择最小产物。下图是可选信息流，不要求每任务创建所有文件；小任务/有价值的只读审查可由一个主文档承载范围、结论、验证与交接。主文档先明确 task_id、owner、授权来源、状态和证据；跨阶段信息确需独立时才拆分并回链。
|
|
|
|
```text
|
|
audit（问题）→ remediation（方案）→ ops/short-term（任务）
|
|
→ test-reports（验收）→ archive（关闭证据）
|
|
```
|
|
|
|
状态字段：`planned | in_progress | blocked | done | cancelled`
|
|
|
|
会话结束不等于任务完成；只有 done/cancelled 任务归档。CURRENT 保留最多 3 项焦点及活跃/阻塞/待集成/待清理事项，完成认领和长证据迁入 [历史快照](archive/ops/2026-09-21-current-history.md)。移动文档同步修复相对链接，保留证据与来源。规范生命周期另用 proposed/approved/active/deprecated；工具能力另用 manual/enforced。
|