其他
在新代理仓库引导、架构变更后刷新文档或做增量漂移检测时…
当需要为代理驱动仓库快速建立或更新项目文档、并在后续运行中检测架构漂移时,用代码库扫描生成 project-doc.md 和 AGENTS.md。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 48/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 85/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 53/100 ×0.15
适用场景
在新代理仓库引导、架构变更后刷新文档或做通用
解决思路
- 首先检查两个可选增强插件是否可用:运行 `/plugin list | grep understand-anything` 检查 understand-anything,运行 `/plugin list | grep context-mode` 检查 context-mode;它们只提升扫描质量,不是必需。
- 如果两个插件都存在,在 Step 3–4 中使用它们;如果任一或全部缺失,改用原生回退方案:直接用 `find`、`grep`、`cat`、`git` 命令;若 context-mode 可用,将大输出通过 `ctx_execute` / `ctx_execute_file` 路由,否则在内联摘要中总结。
- 如需手动安装可选插件,执行 `/plugin marketplace add Lum1104/Understand-Anything && /plugin install understand-anything` 和 `/plugin marketplace add mksglu/context-mode && /plugin install context-mode@context-mode`。
- 判断扫描模式:检查 `.claude/pipeline/project-doc.md` 是否存在;不存在则 FULL SCAN,已存在则 DELTA SCAN。
- Full Scan:用 understand-anything 分析整个代码库;若 context-mode 可用,将所有输出通过 `ctx_batch_execute` / `ctx_execute_file` 路由,绝不把原始文件内容直接倾倒进主上下文窗口;若不可用,逐文件内联总结发现,并避免打印原始文件内容。
- Full Scan:生成 `.claude/pipeline/project-doc.md`,按架构蓝图生成器模式包含:Tech Stack(Runtime、Language、Framework、Database、Styling、State Management)、Dependencies(核心/开发/测试分组及版本)、Architecture Pattern、Folder Structure、Code Style Conventions(从实际代码推断)、Modularity Practices、Data Architecture、Cross-Cutting Concerns、Service Communication、Test Coverage(总体覆盖率、测试框架、关键未测试区域、测试模式)、Entry Points、Changed Files(仅 delta 扫描时出现)、Last Scanned(ISO 时间戳)。
- Full Scan:写完 `project-doc.md` 后,进入 Step 4 生成 `AGENTS.md`。
- Delta Scan:运行 `git diff HEAD~1 --name-only` 获取变更文件。
- Delta Scan:如果没有变更文件,报告“No changes detected — project-doc.md is current”并退出。
- Delta Scan:用 understand-anything 只重新分析变更文件;若 context-mode 可用,通过 `ctx_execute_file` 路由输出,否则内联总结。
- Delta Scan:只补丁式更新 `.claude/pipeline/project-doc.md` 中受影响的部分。
- Delta Scan:更新 `Last Scanned` 和 `Changed Files` 字段。
- Delta Scan:进入 Step 4B 架构变更检测。
- 首次运行时生成 `AGENTS.md` 到仓库根目录;它不是 `project-doc.md` 的副本,而是改写成面向本项目的代理指令,所有代理都先读它。
- `AGENTS.md` 结构应包含:标题与自动生成说明、How to Read This File、Stack Context、Code Style Rules(DO/DON'T,从实际代码模式推断)、Architecture Guardrails(从实际架构推导)、Testing Requirements(覆盖率统计与本项目具体规则)、Modularity Conventions(代码放置规则)、Security Rules(禁止硬编码密钥、使用环境变量、立即标记认证相关变更)、Agent-Specific Instructions(Orchestrator、Architect、Developer、PR Reviewer、QA Agent 各自的项目特定说明)。
- 如果从 package.json / requirements 检测到 MERN 栈(MongoDB + Express + React + Node.js),在 `AGENTS.md` 追加 `### MERN Stack Notes`,覆盖:优先使用 Mongoose 中间件而非原始查询;在 Express 中用中央错误处理器处理异步错误;不要把 JWT token 存在 localStorage,应使用 httpOnly cookies;绝不在 API 响应中直接暴露 Mongoose 错误对象。
- Delta 运行时进行架构变更检测:将新版 `project-doc.md` 与上一版比较,检查是否新增框架或主要库、是否新增架构目录模式(如 `/lib/hooks/`、`/services/`)、是否有重大依赖替换(如 axios → fetch、moment → dayjs)、是否新增认证或会话处理模式。
- 如果检测到任一架构变更,显示警告:`⚠️ Architectural change detected in delta scan:`,列出具体变更,并提示 `AGENTS.md may need updating. Review and confirm:`,提供 `[y] Update AGENTS.md — patch affected sections only` 和 `[n] Skip — this is not an architectural change`。
- 只有当用户确认 `[y]` 时,才补丁式更新 `AGENTS.md` 的相关部分;绝不重写整个文件。
- 打印总结报告:`✅ Scan complete ([FULL/DELTA])`,列出 `project-doc.md → updated`、`AGENTS.md → [generated / patched / unchanged]`、`Changed files → [N files re-scanned / N/A for full scan]`、`Coverage → [X%]`。
- 更新 `state.json` 中字段 `checkpoints.scan = "completed"`。
适用边界 · 注意事项
- 没有代码库或面向空仓库时,扫描无法生成准确的项目专属文档。
- 首次运行或 `.claude/pipeline/project-doc.md` 不存在时,不能执行 delta scan;没有可用 git 历史时,`git diff HEAD~1 --name-only` 增量检测不适用。
- 不希望自动生成/修改 `AGENTS.md`、或不愿对架构变更做人工确认时,不适用。