关于 api-style-guide
用于编写和审核 API 文档的技能，面向工程师、开发者关系团队及合作伙伴。它通过结构、术语、代码示例、元数据和本地化规范，帮助保持文档一致。
主要功能
- 01语言、语气与术语规范
- 02端点结构及格式约定
- 03代码示例与认证处理检查
- 04版本和可用性元数据
- 05无障碍与本地化指导
适用场景
- 01编写或更新 API 参考文档和教程
- 02审核工程师或合作伙伴的文档贡献
- 03发布前检查文档一致性
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/api-style-guide确认已加载。
详细介绍
API 风格指南技能
适用场景
- 编写或更新 API 参考文档、教程和 SDK 文档。
- 审查工程师、DevRel 或合作伙伴的贡献。
- 在发布前审核文档的一致性。
框架
- 语言与语气——针对受众的语气、术语表和禁用短语。
- 结构——端点和顺序约定、表格布局、代码块格式、错误文档模式。
- 代码示例——命名标准、身份验证处理、分页模式、行内注释。
- 元数据与标签——版本标签、可用性说明、Beta 标记、区域指示。
- 无障碍与本地化——标题层级、替代文本、代码片段注释、翻译指南。
模板
- 参考条目模板（描述、参数、响应、示例、备注）。
- 教程框架，包含前提条件、步骤、故障排除和后续步骤。
- 代码示例检查清单，确保包含环境变量、注释和错误处理。
提示
- 确保示例可运行；即使主要示例使用其他语言，也要提供等效的
curl示例。 - 链接到术语表，以便团队间共享术语。
- 配合
update-api-reference命令使用，以确保输出一致。
评论
支持 Markdown