SuperAPI AI 工具集

synapse-docs

通用与其它

查看项目

更新于 10-16 09:35

技能介绍

synapse-docs 是 Synapse A2A 项目的文档同步技能,用途是让项目文档在代码变更后保持同步。

主要能力:在核心模块(synapse/.py、synapse/commands/.py)、配置文件(synapse/profiles/.yaml)、模板(synapse/templates/.synapse/)、插件与技能(plugins/synapse-a2a/**/*)以及 pyproject.toml(版本、依赖、入口点)变化时自动触发;也可通过 /synapse-docs 手动触发完整文档检查与更新。

使用方式:工作流分四个阶段。阶段1检测变更,依据 references/code-doc-mapping.md 定位受影响文档,例如 CLI 命令对应 README.md 与 guides/usage.md,API 端点对应 README.md 与 guides/references.md,环境变量对应 README.md、guides/settings.md 与 templates/.synapse/settings.json,Profile 设置对应 guides/profiles.md,技能内容对应 plugins/*/SKILL.md 并同步到 .claude/skills/ 与 .agents/skills/。阶段2针对每份文档读取当前内容、定位需更新的具体章节、提出最小必要修改并交用户批准,要求保持原有风格、仅更新受影响章节、README.md 保持简洁并将细节放入 guides/。阶段3同步相关文件,将 plugins/synapse-a2a/skills/ 中的技能分发到 .claude/skills/ 和 .agents/skills/,并保持模板与 guides/settings.md 一致。阶段4执行一致性校验,比对 CLI 命令、API 端点、端口范围和环境变量在相关文档间是否一致。

适用场景:代码变更需要文档更新、检查文档一致性、版本发布更新 CHANGELOG.md、新功能加入 README 功能表与相应指南、弃用功能时标注弃用并添加迁移指南。

限制:仅面向 Synapse A2A 项目自身的文档维护,不适用于其他项目;所有文档修改需用户批准;资料未说明其独立安装方式、支持平台或收费情况,暂未提供。