SuperAPI AI 工具集

gen-docs

写作与研究

查看项目

更新于 10-16 01:19

技能介绍

用途:当代码库发生影响产品行为或用户体验的变更时,用此技能更新对应文档。仓库在 docs/ 下维护中英双语文档:docs/en/ 与 docs/zh/ 大多数页面成镜像对,需在同一变更中同时更新;变更日志例外,英文为源、中文由英文翻译而来。若需发布前全量审计(检测幻觉与覆盖缺口),应改用 audit-docs 技能。

前置条件(缺失则停止并向用户报告):docs/ 目录含 docs/zh/、docs/en/、docs/.vitepress/config.ts(VitePress 站点);docs/AGENTS.md 风格指南(定义事实来源规则、术语表、排版与写作风格);docs/scripts/sync-changelog.mjs(将根 CHANGELOG.md 自动同步到 docs/en/release-notes/changelog.md);.agents/skills/ 中的 translate-docs 技能(处理双语同步)。

工作流程:一、检查变更,用 git log main..HEAD --oneline、git diff main..HEAD --stat、ls .changeset/*.md(排除 README.md),并读取 CHANGELOG.md 及各子包 CHANGELOG.md。二、理解用户可见影响,必要时阅读实际实现,不依据提交信息或 PR 标题推断行为;跳过无外部行为变化的内部重构、测试、CI、纯类型变更,以及不改变 CLI 调用方式的工具或构建变更;若无用户可见影响则说明并停止。三、同步英文变更日志,运行 node docs/scripts/sync-changelog.mjs,不要手改该文件。四、按 docs/AGENTS.md 规则更新受影响页面并同步镜像,涵盖指南、自定义、配置、参考与发布说明各相关部分。五、调用 translate-docs 技能同步非变更日志页面,并将英文变更日志翻译为中文。

规则:非变更日志页面保持中英镜像,变更日志为英译中;严格使用术语表,不新造译名;仅更新受影响部分;示例使用中性占位符如 https://api.example.com/v1、example.test、YOUR_API_KEY,不写真实内部端点或账号;若为破坏性变更,需在 docs/en/release-notes/breaking-changes.md 的 ## Unreleased 下补充 Affected 与 Migration 小节并镜像中文;docs/en/release-notes/changelog.md 由脚本重新生成,手动修改会被覆盖。常见错误包括描述代码改动而非用户能做什么、每个功能新增独立标题、只更新单语言、新造术语、示例使用真实内部值。