藏在《Harness Step 2 — 填充 docs/ 知识库内容》里的Skill

技能描述

深度阅读项目代码,将隐藏在代码里的架构知识、命名约定、技术决策显式写入 docs/ 各文件,让 agent 在任何 session 都能快速理解项目全貌,而不是靠猜测。

Skill.md

Harness Step 2 — 填充 docs/ 知识库内容

docs/ 骨架创建后,最常见的问题是:文件存在,但内容是占位符。agent 读到"命名规则:见代码"这种文字,等于什么都没读。这个 skill 解决这一问题——深度读懂代码,把隐性知识变成显式文档,每条规则都有代码实例支撑。

会填充哪些文件

文件填充内容
docs/ARCHITECTURE.md模块职责、依赖方向规则(带原因)、主要数据流
docs/CONVENTIONS.md文件命名规律(含实际示例)、变量/函数命名规律
docs/TECH_DECISIONS.md每个主要库/框架的选型原因(能推断则推断,不能则标注「待补充」)
docs/QUALITY.md项目特有的完成定义、代码审查检查清单
docs/exec-plans/tech-debt-tracker.md扫描中发现的重复代码、命名不一致、TODO 注释等

核心原则

推断出来的内容标注来源,无法确定的内容标注「待补充」——不用模糊占位符糊弄过去。

扫描结束后,skill 会给出一份「待补充」清单,这是需要你人工确认的部分。大多数项目通常有 3-5 个这样的条目,主要集中在:

  • 技术选型的历史原因(代码里只有结论)
  • 性能基准和 SLA(需要实测数据)
  • 团队约定俗成的习惯(没有写在代码里的规范)

支持的使用场景

  • Step 1 建好骨架后,立即填充实质内容
  • 项目经历重大重构后,更新文档与代码的一致性
  • 接手他人项目,快速生成自己能看懂的架构说明

使用方式

  1. 确认项目中已有 AGENTS.mddocs/ 目录(运行 Step 1 生成)
  2. 说"填充文档内容"或"写 ARCHITECTURE.md"
  3. Skill 扫描入口文件、模块边界、依赖声明、命名模式
  4. 写入所有 docs/ 文件,列出「待补充」清单
  5. 你只需要确认或补充那些 skill 无法推断的内容

局限说明

Skill 从代码推断,不访问 git history 或团队沟通记录。历史决策原因("为什么当时选了 X")通常需要人工补充;运行时行为(API 响应格式、实际查询性能)无法从文件中读取。

安装使用

安装指令

npx skills add simbajigege/book2skills/skills/harness-step2-fill-docs
OR

直接下载

相关技能

Tool Permission System AI Skill

为 agent 工具设计可配置的分层权限/安全系统:用一条权限流水线统一决定 allow / ask / deny,支持企业 / 用户 / 项目多作用域规则覆盖,并通过 hook 系统扩展。

Harness Step 1 — 创建 AGENTS.md 与知识库 AI Skill

扫描项目代码库,自动生成 AGENTS.md(agent 工作指南)和完整的 docs/ 知识库骨架,让 Claude Code 在任意新会话中 30 秒内定向,无需重复解释项目结构。

Harness Step 3 — 建立跨 Session 状态管理 AI Skill

创建 init.sh(环境健康检查)、tasks.json(结构化任务队列)和 progress.md(会话日志),解决 Claude Code 每次新对话失忆的问题,让任意 session 在 30 秒内完全恢复工作状态。

Session Dream AI Skill

会话结束时的手动记忆提炼——从当前对话中提取关键决策、失败路径、新发现和当前阻塞,写入 MEMORY.md topic 文件。Claude Code autoDream 后台服务的手动触发版本。

Claude Code 记忆架构实现指南 AI Skill

将混乱的 MEMORY.md 重构为 Claude Code autoDream 内部使用的 2 层记忆架构 —— 保持常驻索引精简、主题文件按需加载,让 autoDream 提取代理正确去重和维护记忆。

Compact with Memory AI Skill

正确执行 /compact——生成高质量的对话摘要,完整保留推理过程、决策背景和当前状态,同时在压缩前通过记忆预处理持久化机构知识。

LangChain Tool Builder AI Skill

用 Claude Code 的 fail-closed 设计模式定义 LangChain(Python)工具——name、schema、权限、执行逻辑统一写在一个类里,自动走 validate → permission → call ...

Compact Memory 实现指南 AI Skill

用 Anthropic API 或 Claude Agent SDK 为 Agent 实现 compact memory 的开发者指南——涵盖触发时机、fork compactor 模式、compact JSON schema 设计、...

Query Loop Implementation AI Skill

为 AI 应用实现可上线的 LLM query loop:工具调用、结构化 tool_result 回传、ReAct 循环、最大轮次退出、权限检查、超时、预算控制和 fatal error 终止路径。

一本书读懂财报 AI Skill

用肖星的三表联动框架分析企业财务报表,判断一家公司是否真正赚钱。适用于:解读资产负债表、分析现金流健康度、ROIC vs WACC好公司测试、跨行业财务比较。

商业冒险分析框架 AI Skill

运用约翰·布鲁克斯《商业冒险》(原书名《Business Adventures》)分析企业失败、市场恐慌、产品时机、治理缺口、监管风险、欺诈暴露、机构脆弱性和创新盲区。