用途:在撰写或更新 API 参考、教程与 SDK 文档时提供风格与格式规则;也用于审阅工程师、DevRel 或合作方提交的内容,以及在发布前审计文档一致性。
主要能力:框架涵盖语言与语气(面向特定受众的语气、术语表、禁用短语)、结构(端点与顺序约定、表格布局、代码块格式、错误文档模式)、代码示例(命名标准、认证处理、分页模式、行内注释)、元数据与标签(版本标签、可用性说明、beta 标记、语言区域标识)、无障碍与本地化(标题层级、替代文本、片段注释、翻译指引)。
模板:提供参考条目模板(描述、参数、响应、示例、备注)、教程骨架(前置条件、步骤、故障排查、后续步骤)以及代码示例检查清单(确保包含环境变量、注释与错误处理)。
使用方式:按上述框架与模板撰写或审阅文档;建议保持示例可运行,即使主示例使用其他语言也提供 curl 等价写法;链接术语表以统一跨团队术语;可搭配 update-api-reference 命令以强制输出一致。
适用场景:API 参考、SDK 文档、教程编写与审阅,发布前文档审计。
限制:资料未提供具体安装命令、收费、价格、平台或效果信息。