SuperAPI AI 工具集

document-sync

写作与研究

查看项目

更新于 10-15 16:49

技能介绍

用途:document-sync 用于让项目文档与真实代码保持一致。它依据实际代码库、依赖、配置和架构,端到端比对文档内容,发现过时、错误、缺失或多余的描述,并给出更新方案。核心原则是“先验证、不臆测”,只有比对到真实代码与依赖后才更新;并提供文档信任评分。

主要能力:检测技术栈(解析 package.json、requirements.txt、pom.xml 等);分析项目结构与架构,包括数据流、认证方式、同步策略和部署形态;清点 Markdown、docs/、README 等文档并逐条对照代码与配置;将文档标为最新、需更新、过时或缺失;按需生成报告与更新计划。阶段一输出 system_state.json 与 code_features_report.md,阶段二输出 doc_verification_report.md 与 docs_update_plan.md。

使用方式:可用自然语言指令,如“Run document sync analysis on my project”“Update docs so every API route matches the code”。也可用斜杠命令:/docs-sync、/docs-update-strict、/docs-rewrite-missing、/docs-patch-pr。脚本流程为:python3 .claude/skills/document-sync/scripts/system_scan.py,python3 .claude/skills/document-sync/scripts/verify_docs.py,以及 python3 .claude/skills/document-sync/scripts/update_docs.py --mode=dry-run(同命令支持 --mode=suggest 与 --mode=auto-update)。项目根目录可建 .claude/document-sync-skill.yml 配置 mode、protected_docs、review_required_for、output_reports。

适用场景:需要长期维护文档、发布前核对文档、补齐未记录功能或清理过时引用的项目。

限制与安全:不会在没有明确代码证据时删除或重写文档,修改前创建差异与备份,保守程度由用户在 dry-run、仅建议、自动更新中选择,改动可追溯。资料还包含要求用户人工确认修复的验证条款。