用途
Documentation Inversion(文档反转)用于解决传统文档与代码脱节、逐渐过时的问题。传统流程是“开发者发布功能→写 wiki 文章→代码被重构→wiki 从不更新→后续开发者或智能体依据过时文章产生错误假设”。该方法将文档流程反转为“代码→CLAUDE.md→面向智能体的技能”,让指导信息直接存在于代码库中,使 AI 能探索源码并按需找到当前信息。
核心原则
为程序化导航而结构化文档:层级化、交叉引用、具有明确入口点,使 AI 智能体无需人类引导即可找到所需内容。传统文档假设人类读者会浏览、搜索并解读上下文;面向智能体的文档假设机器读者需要:明确入口点、结构化层级、可程序化跟随的交叉引用,以及下一步探索的指引。
主要能力
三层文档体系
- 第 1 层:CLAUDE.md 文件(按目录,自动加载)。范围为一个目录或模块;内容为用途、入口点、约定、交叉引用;由拥有该模块的团队维护;在代码评审时随代码变更更新。
- 第 2 层:导航技能(按库,按需加载)。范围为一个库或子系统(可跨多个目录);内容为探索流程、常见任务、反模式;由创建该技能的团队或开发者维护;在库架构变化时更新。
- 第 3 层:插件包(可分发、可安装)。范围为一个库或框架的可分发技能集合;安装到项目后技能按需加载;内容涵盖导航、贡献、故障排查等多个技能;由库维护者或社区维护;在重大版本变化或新增技能时更新。
CLAUDE.md 的层级与继承
CLAUDE.md 是层级化的:智能体进入某目录时会加载该目录及其所有父目录直至项目根目录的 CLAUDE.md。例如在 src/auth/oauth/ 工作时会依次加载项目根、src/、src/auth/、src/auth/oauth/ 的 CLAUDE.md。层级用途建议:项目根放语言、构建命令、Git 约定、整体架构;src/ 放编码约定、导入模式、错误处理模式;模块级放模块专属入口点、类型、依赖;子模块级仅在存在子模块专属约定时使用。
面向机器消费的设计
CLAUDE.md 应使用标签化章节、项目符号列表和表格,而非叙事性段落;提供专门的“入口点”章节并给出精确文件路径;枚举类型信息及其源码位置;省略历史背景(智能体只需当前状态);将编码标准写成明确规则;交叉引用使用精确路径(如 ../api/CLAUDE.md#authentication)。
使用方式
第 1 步:每个模块放置 CLAUDE.md
在重要模块、库或目录根部放置 CLAUDE.md,包含:用途(一段话说明模块做什么及为何存在)、入口点(如 src/index.ts 为公共 API 表面,src/core/engine.ts 为核心逻辑)、架构与关键文件表、约定(命名、错误处理、测试模式)、依赖、交叉引用。好的 CLAUDE.md 应层级化、交叉引用、聚焦入口点、记录约定、简短(100 行以内)。
第 2 步:创建导航技能
导航技能教智能体如何探索库或模块,描述理解过程而非当前状态。模板包含:快速定位(读根 CLAUDE.md、src/index.ts、src/core/types.ts)、理解架构(从入口点开始、追踪主流程、列出关键抽象)、常见任务(新增功能、修复缺陷、理解特定功能)、应避免的反模式。技能是配方而非快照,因此代码变化时依然有效。
第 3 步:打包为插件
将相关导航技能打包为 Claude Code 插件,目录结构如:{library-name}-docs/ 下含 plugin.json 和 skills/(navigation/SKILL.md、contributing/SKILL.md、troubleshooting/SKILL.md)。plugin.json 包含 name、description、version 字段。
第 4 步:智能体按需加载
智能体遇到该库时,插件技能出现在其可用技能集中;需要处理该库时加载导航技能;技能引导智能体读取 CLAUDE.md 并探索当前源码;智能体基于当前代码而非过时文档建立理解。
适用场景
- 代码库中模块较多、文档容易过时的团队。
- 希望 AI 智能体能在不熟悉代码中自主定位并有效贡献的项目。
- 从 wiki 或 Notion 等外部文档系统迁移到代码内文档的团队。
- 需要为库或框架提供可分发、可安装的智能体文档的维护者。
迁移路径
- 阶段 1(1-2 天):为 5-10 个最重要模块创建 CLAUDE.md,添加根 CLAUDE.md,暂不删除 wiki。
- 阶段 2(1-2 天):为主要库或子系统创建导航技能,聚焦探索过程,打包为插件并测试。
- 阶段 3(持续):在代码评审清单中加入“此变更是否需要更新 CLAUDE.md?”,新模块要求随 PR 提供 CLAUDE.md,发现过时文档时更新 CLAUDE.md 而非 wiki。
- 阶段 4(就绪时):审计每个 wiki 页面确认信息已存在于 CLAUDE.md 或技能中,归档 wiki(不删除),将文档问题重定向到“阅读相关目录的 CLAUDE.md”。
文档健康度
过时信号包括:CLAUDE.md 6 个月以上未更新但代码显著变化;智能体频繁忽略 CLAUDE.md 指导;智能体对有 CLAUDE.md 的模块仍提出澄清问题;新成员仍依赖口口相传。健康指标包括覆盖率(多少重要模块有 CLAUDE.md)、新鲜度(CLAUDE.md 最后更新相对模块最后代码变更的时间)、有用性(有 CLAUDE.md 时智能体输出是否更好)、完整性(是否包含用途、入口点、关键文件、约定)。
反模式
- 将 CLAUDE.md 当作代码堆砌:列出每个文件和函数。应聚焦入口点和导航。
- 使用叙事性散文而非结构:应使用表格、列表和标签化章节。
- 重复代码注释:CLAUDE.md 应描述模块级视图,函数级视图交给代码注释。
- 从不更新 CLAUDE.md:应将更新纳入代码评审流程。
- 根目录只有一个巨型 CLAUDE.md:应使用层级结构,根放项目级约定,各模块有自己的 CLAUDE.md。
与 SDD 的集成
文档反转是 SDD 上下文架构的自然延伸:上下文目录结构对应按模块共置的 CLAUDE.md;渐进式披露对应从项目根到叶模块的 CLAUDE.md 层级;规格作为真相来源对应 CLAUDE.md 作为每个模块的权威指导产物;技能编码可复用流程对应导航技能编码可复用探索工作流;插件作为分发机制对应文档插件打包技能供其他项目安装。
限制
资料未提供该技能的具体安装命令、收费方式、支持平台或效果数据。