SuperAPI AI 工具集

sync-docs

写作与研究

查看项目

更新于 10-16 08:10

技能介绍

用途:保持 CLAUDE.md(面向 Claude 的项目指令)和 README.md(面向用户与开发者的公开文档)与项目实际状态同步。

主要能力:

  1. CLAUDE.md 管理:扫描项目结构,发现新工具、脚本与构建系统;同步 package.json、Makefile 或构建配置中的构建命令;补充编码约定与文件组织模式;刷新 lint、测试、部署等命令;核对环境安装与设置步骤。
  2. README.md 维护:更新依赖、要求与安装步骤;校验代码示例和 API 文档;检查外部链接、徽章与引用是否有效;更新功能、路线图与版本信息;确认截图或演示是否为当前状态。
  3. 智能检测:文件缺失时创建 CLAUDE.md 或 README.md;分析自上次更新以来的代码库变更;将项目结构与文档指令交叉比对;自动识别过时内容;检查两份文件是否互补一致。
  4. 验证步骤:运行文档中提到的项目命令确认可用;从全新视角测试安装步骤;验证所有外部链接与引用;确认 CLAUDE.md 指令与当前项目设置一致;确保 README.md 准确反映当前项目状态。

适用场景:需要同时维护 AI 协作指令和公开 README、且希望减少文档滞后或失真的项目。

限制:资料未提供具体安装命令、调用方式、收费方式或平台支持信息,暂未提供。