4.3 KiB

Raw Permalink Blame History

APS Agent 文档大管家

本文件是文档体系的唯一入口。
改代码、加功能、改功能、改门禁、改模块登记——同一轮必须在本体系留痕，否则视为交付未完成。

1. 目录地图（按角色分类）

目录	读者	内容
`CHANGELOG.md`	全员	变更登记簿：每次代码/功能变动一条记录（大管家的账本）
`product/`	产品经理 / 业务方	定位、功能清单、业务旅程、验收口径
`architecture/`	架构 / 后端 / 前端	分层、门禁、可重生模块、契约与数据流
`algorithm/`	算法 / OR / 数据	已落地求解逻辑、冲突语义、目标算法路线
根目录 `plan.md`	全员（蓝图）	完整架构蓝图；细节以本 `docs/` 落地文档为准

旧扁平文件（PROGRESS.md / FEATURES.md / HARNESS.md / REGEN.md）已迁入上述分类，请勿再往根下堆新文档。

2. 写文档的硬规则（活文档铁律）

2.1 什么时候必须改文档

你改了什么	必须更新
任意功能增删改、修 bug、改交互	`CHANGELOG.md` 追加一节
产品能力边界 / 功能状态	`product/features.md`
核心用户路径或业务语义	`product/journeys.md`
`_POWER_MAP`、API 端点权限	`architecture/harness.md`
`moduleId` 增删改名	`architecture/modules.md`
排产规则、冲突类型、策略模板	`algorithm/scheduling-v1.md`
架构分层、技术选型重大变更	`architecture/overview.md` + 必要时同步 `plan.md`

2.2 CHANGELOG 写法（强制模板）

## YYYY-MM-DD — 一句话标题

- **类型**：feature | fix | refactor | docs | chore
- **做了什么**：3～8 条，写结果不写流水账
- **涉及路径**：关键文件/目录
- **验证**：命令 + 结果（如 `24 passed` / 构建成功）
- **文档同步**：勾选本次已改的文档
- **遗留**：未做完的点（可空）

2.3 真相优先级（防「文档骗人」）

可运行代码与黄金测试 > 本文档 > plan.md 蓝图
文档里写「已落地」必须能在代码里指到路径；写「规划中」必须标明未实现
禁止把演示数据写成产品定位（本产品无行业/工厂硬编码）

3. 快速导航

产品经理

架构 / 研发

算法

本地跑起来

见仓库根 README.md。

4. 文档维护责任

角色	责任
每次改代码的 Agent / 开发者	同一轮更新 CHANGELOG + 对应分类文档
产品评审	以 `product/` 为准验收，不以聊天记录为准
架构评审	以 `architecture/` + `plan.md` 为准；冲突时先改文档再改代码或反过来同轮对齐

大管家索引 · 与代码同生命周期维护

4.3 KiB Raw Permalink Blame History Unescape Escape

APS Agent 文档大管家

1. 目录地图（按角色分类）

2. 写文档的硬规则（活文档铁律）

2.1 什么时候必须改文档

2.2 CHANGELOG 写法（强制模板）

2.3 真相优先级（防「文档骗人」）

3. 快速导航

产品经理

架构 / 研发

算法

本地跑起来

4. 文档维护责任

Round 65 闭环 APS 索引

4.3 KiB

Raw Permalink Blame History