README.md 6.51 KB

docs 索引

文档按状态分为三个目录:

  • done/ — 描述已实现 / 当前有效的架构与功能的文档(含长期参考手册)。
  • todo/ — 当前正在推进的路线图/设计草案。
  • todo/future/ — 尚未实现、但不是当前重心的待办(暂缓,等主线腾出手再回来处理)。

判断依据:文档正文的显式「状态」标记(✅ 已完成 / 已实现 vs 📝 设计中 / 未实现)、未勾选的 checklist,以及与代码库实际实现的交叉核对(见各条目备注)。

当前主线:Graph Agent 架构重构(27-graph-agent-architecture.md)。该系列已完成的阶段文档(P1/P2)移入 done/,其余非主线待办在 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/agents/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/27-p1-virtual-reference.md P1 虚拟引用寻址 — ✅ 已实现(commit 226489d,server/services/graph-service.js):agent.md 不再逐公司拷贝,改为 config.json.systemAgentRef 引用 + company-context.md 承载公司语境
system-design/27-p2-org-graph.md P2 Org Graph — ✅ 已实现(70a4727 + f20d0d8):org graph 定位为 company 级 workflow(执行流边),orggraph-planning agent 建公司时自动规划并招聘。真实建公司端到端验证通过
system-design/01-26 系统设计正文 01~26 章(14、25-harness-engineering-improvements 例外,见 todo/future/;27 例外,见 todo/),各章节状态见文内「状态」标记

todo/(当前主线)

Graph Agent 架构重构(27 系列)。已完成的阶段文档已移入 done/(P1、P2),下面是仍在推进或长期有效的部分。

文件 说明
27-graph-agent-architecture.md 总纲。P0-P6 分阶段路线图与整体架构。P0-P3+P4 已实现,P4(新)/P5/P6 待做
27-requirement.md 需求源头。用户原话照搬(R-1..R-16)+ 需求→设计落点速查。其余文档都是对它的转述,出现分歧以此为准
27-naming-conventions.md 命名规范。{作用域}-{职能};图节点按层级轴命名;节点名 ≠ 本体名;三种 benchmark 消歧;OKR 正名。新增 agent id / 表名 / 字段名前必读
27-e2e-task-execution-flow.md 端到端流程总览:建公司 → 下达任务 → org graph 逐节点执行 → work graph 规划与循环 → 验收收敛。含与 DevLoop 既有实现的对应关系分析
27-example-dev-company-walkthrough.md 参考场景走查(虚构的「配图工厂」),把架构跑一遍具体的数:各阶段 JSON 形态、成本估算、断点清单
27-p3-p4-work-graph-console.md P3+P4(原 P4 回退+Loop-Validator 已并入)图执行引擎与执行控制台 — ✅ 已实现(c3abf4a),文档仍在补充中
27-goal-contract-format.md 验收契约格式(goal-benchmark / goal-test-data / goal-test-script 的产物形态与跨节点传递)
27-p4-parallel-and-artifacts.md P4(回收编号)并行执行与产物索引 — 📝 设计中。fan-out 真并发 + 同 agent 多实例隔离 + files.json 产物索引。三个 Phase,C 可插队

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/。