SuperAPI AI 工具集

doc-sync

写作与研究

查看项目

更新于 10-15 16:46

技能介绍

用途:doc-sync 用于在代码仓库范围内同步文档,核心是维护 CLAUDE.md 的导航索引层级,以及 README.md 中的隐性知识(架构、设计决策等)文档。当用户提出「sync docs」「update documentation」或指定路径的文档同步需求时使用。该技能自包含,直接完成全部文档工作,不依赖外部权威来源。

主要能力与工作流:

  1. 范围判定。用户请求「sync docs」或无路径时为全仓库范围;指定目录时限定该目录及后代;指定文件时定位其父目录。全仓库范围执行完整审计。
  2. 发现阶段。用 find 命令扫描需要核验 CLAUDE.md 的目录,排除 .git、node_modules、pycache、.venv、target、dist、build 等。

Find all directories (excluding .git, node_modules, pycache, etc.)

find . -type d ( -name .git -o -name node_modules -o -name pycache -o -name .venv -o -name target -o -name dist -o -name build ) -prune -o -type d -print 3. 审计阶段。逐目录检查 CLAUDE.md 是否存在、是否采用表格索引结构、索引与实际文件是否漂移、触发条件是否面向任务、是否混入错位内容,以及 README.md 是否存在与是否必要。 4. 内容迁移。将 CLAUDE.md 中解释「为什么」的内容(架构说明、设计决策、不变量、约束、依赖说明、目的性段落等)迁移至 README.md;CLAUDE.md 仅保留操作类内容(构建、测试、再生成、部署等可复制命令)。判断标准是「解释 WHY 还是说明 HOW」。 5. 索引更新。按根目录或子目录模板创建/更新 CLAUDE.md;「What」列写事实性描述,「When to read」列写面向动作的触发语;README.md 若存在需列入文件表。README.md 仅在存在隐性知识时创建,需自包含,不引用外部权威来源。 6. 验证。确认范围内每个目录都有 CLAUDE.md、均为纯索引格式、无漂移、无错位内容、README.md 已被父级索引、README.md 自包含。

输出为 Doc Sync Report,含范围、变更列表(创建/更新/迁移/标记)与验证统计(目录数、覆盖率、格式、漂移修复、迁移数等)。

排除项:不为生成文件目录(dist、build 等)、第三方依赖(node_modules、vendor、third_party)、.git、IDE 配置、仅含 .gitkeep 的存根目录创建 CLAUDE.md;不索引生成文件与依赖文件,但需索引影响开发的隐藏配置文件、测试文件与文档文件。

不适用场景:单文件文档、代码注释、函数/模块 docstring,这些应直接处理。本技能专用于 CLAUDE.md/README.md 的同步。更多触发模式示例见 references/trigger-patterns.md。

限制:资料未提供该技能的价格、收费方式、支持的平台或运行环境等事实,暂未提供。