跳到主要内容

项目整改清单

给项目级 Agent 用。接到「整改 / 清理 projects/<id>/」任务时按本清单走。每条做完打勾,全部勾完即「done」

前置阅读

  1. 本仓根 Agent 入口约定
  2. 落点决策树
  3. 项目 README 模板
  4. 接入指南 §4「文档基本规范」

A. README 合规

  • frontmatter 5 字段齐全(title / status / last-updated / scope / maturity
  • status 与项目当前实际匹配(不是上次写完就忘了改)
  • last-updated 反映本次整改完成日期
  • 整体行数 ≤ 120 行
  • 结构与本项目 maturity 在 projects/README.md 中的分级一致
  • 一句话定义在前 3 行内说清「是什么 / 给谁 / 关键边界」

B. 内部文档质量

逐份遍历 projects/<id>/**/*.md,每份检查:

  • frontmatter 5 字段齐全
  • 正文不出现个人主目录路径、私有工程仓绝对路径、容器工作目录
  • Markdown 链接显示文本是人可读名称(不是 ../../foo.md
  • 单篇不中英文混排(默认中文;专名 / 代码 / URL 例外)
  • 本文档使用的特有术语(如 /goal)有源头说明可点链接
  • 引用 ecosystem / commons 的资料用相对路径链接,不复制粘贴正文

C. 跨项目接口对齐

D. 归档处理(如有)

  • 退役文档已挪到 _archive/projects/<id>/<YYYY-MM-DD>-<reason>/
  • 活跃目录留 tombstone 或在 README 归档段落留索引
  • 归档不触发 verify:kb(_archive/** 已在 EXCLUDED_SEGMENTS 内)

E. Agent 派生入口

  • for-agents/projects/<id>/context.json 的 source_refs 与项目实际文档一致
  • 改完 .md 后跑 npm run derive,stage 派生差异一起 commit
  • commit 不被 pre-commit hook 的 derive:check 阻断

F. 校验闭环

  • npm run verify:kb,全绿
  • npm run build,构建无报错(onBrokenLinks: throw 不允许死链)

G. 状态记录(可选,轻量)

如果你的项目会话需要在不开会的情况下让 main-orchestrator 看到进度:

  • projects/<id>/.cleanup-status.md 写一行:YYYY-MM-DD: cleanup checklist complete (Agent: <tool/model>)
  • .cleanup-status.md 不进 docusaurus(依赖 sidebars exclude 配置),可选择是否进 git

不需要这层可见性就跳过 G。

H. 上报方式

  • commit message 注明:chore(<id>): cleanup per project-cleanup-checklist
  • 不要在仓内写「已完成 checklist」公告文档——git log + .cleanup-status.md 已经够

反模式(别犯)

  • ❌ 一次性整改多个项目(你只负责 projects/<id>/,不动其它项目)
  • ❌ 改 ecosystem/commons/(main-orchestrator 的活;如有需求走 governance/change-protocol.md L1 提案)
  • ❌ 改 for-agents/ 下任何非 topics/<id>/agent-pack.yaml 的文件
  • ❌ 改 sidebars.js / docusaurus.config.js(呈现层归 main-orchestrator)
  • ❌ 删除 _archive/ 内容(_archive 是只读的历史)