README.md
4.39 KB
docs 索引
文档按状态分为三个目录:
done/— 描述已实现 / 当前有效的架构与功能的文档(含长期参考手册)。todo/— 当前正在推进的路线图/设计草案。todo/future/— 尚未实现、但不是当前重心的待办(暂缓,等主线腾出手再回来处理)。
判断依据:文档正文的显式「状态」标记(✅ 已完成 / 已实现 vs 📝 设计中 / 未实现)、未勾选的 checklist,以及与代码库实际实现的交叉核对(见各条目备注)。
当前主线:Graph Agent 架构重构(27-graph-agent-architecture.md)。
todo/下只保留这一份,其余待办已移入todo/future/,避免和主线抢注意力。
done/
| 文件 | 说明 |
|---|---|
| LEMONBOSS-SYSTEM-DESIGN.md | 系统设计主索引 v2.0,含 27 章 system-design/ 的总目录 |
| architecture-v5.md | v5.3 架构方案,Phase 1-6 已完成(Phase 7 认知架构条目单独见 todo/) |
| claude-code-cron.md | Claude Code 原生 Cron 调度功能参考手册 |
| open-api-manual.md | ArenaSK Open API 外部调用手册 |
| qa_judge_req.md | QA Judge Agent 需求文档 — 已在 system/templates/qa-judge/ 落地 |
| task_timeline_design.md | Task Timeline View 设计文档 — 已实现(server/routes/tasks.js、server/services/task-service.js、web/src/views/TaskTimeline.vue) |
| user-guides/08-base-agent-4-phase-guide.md | Base Agent 四阶段使用指南 |
| system-design/01-26 | 系统设计正文 01~26 章(14、25-harness-engineering-improvements 例外,见 todo/future/;27 例外,见 todo/),各章节状态见文内「状态」标记 |
todo/(当前主线)
| 文件 | 说明 |
|---|---|
| system-design/27-graph-agent-architecture.md | Graph Agent 架构,状态:📝 设计中,未实现。P0-P6 分阶段路线图,当前唯一在推进的重构 |
| system-design/27-p1-virtual-reference.md | P1(虚拟引用)细化需求与设计文档:getAgentConfig()/PromptBuilder.build()/hire() 的具体改法、验收标准、blast radius、未决问题 |
todo/future/(暂缓,非当前重心)
| 文件 | 说明 |
|---|---|
| architecture_todo_list.md | FDE Pipeline 架构待办清单(Judge 系统 / 反馈闭环等五大维度)。与 Graph Agent 架构基本正交,其中第 4 点「版本回滚」与 27 号文档 P5 阶段的 git 版本化 memory.md 有部分重叠,P5 落地后可回来划掉 |
| system-design/14-milestones.md | 早期里程碑规划(v1.1,checklist 未勾选)。已被后续实际实现大幅绕过,主要留作历史存档,不建议优先处理 |
| system-design/25-harness-engineering-improvements.md | Harness Engineering 改进提案(单 Agent 上下文管理),Phase 3-5 未落地。与 Graph Agent 架构(多 Agent 组织/图执行)维度不同,互不阻塞 |
未纳入整理的目录
以下目录本身是活跃系统的一部分(不是静态文档),保持原位不动:
prd/— DevLoop 的 PRD/SDD 规格站点源文件。prd/newfunction/*.html由npm run spec:extract读取生成prd/newfunction/_spec/*.md,是代码依赖的机器可读规格,不是待归档的说明文档。create-drama/— 独立的 Skill 工具子项目(含自身package.json/node_modules),不是设计文档。
维护说明
新增文档时,先判断它描述的是已实现的能力(放 done/)、当前正在推进的重心(放 todo/),还是尚未开始且非当前重心(放 todo/future/)。功能落地后,将对应文档从 todo/(或 todo/future/)移到 done/ 并更新本索引与 LEMONBOSS-SYSTEM-DESIGN.md 中的链接;当主线切换时(比如 Graph Agent 架构完成后),把 todo/future/ 里优先级提升的条目挪回 todo/。