用途:该技能面向 Azure 技术文档编写与审校,用于确保文档中的 API 定义、REST 调用和参数名称遵循统一标准,并与官方规范保持一致。适用于需要检查 API 调用、CLI 参数或 REST 一致性的场景。\n\n主要能力:扫描文档中的 REST API 调用(HTTP 方法、URL、JSON 请求体),扫描 CLI 参数(如 --resource-group、-g),并做一致性检查。检查项包括:同一类参数不要混用大小写风格(例如一处用 resourceGroupName、另一处用 resource-group-name,除非 SDK 与 CLI 语境确有要求);相关调用之间的 API 版本(如 2023-01-01)应保持一致;参数可疑时通过 microsoft_docs_search 对照标准模式验证;识别不一致的参数命名(camelCase 与 kebab-case);识别新旧 CLI 命令组混用(如 az scvmm 与 az arc-vmm,应统一倾向较新者);识别偏离标准 ARM 模式的 URL 结构(/subscriptions/.../resourceGroups/...)。\n\n使用方式:以文档检查任务触发,技能会先扫描 REST 与 CLI 内容再逐项核对。修复规则是最小改动,只修改不一致的术语,不改动其他内容。\n\n适用场景:Azure 文档的 API 与 CLI 表述统一、版本一致性与参数命名规范的审校。\n\n限制:仅覆盖所给文档范围内的一致性检查,官方规范核对依赖 microsoft_docs_search;具体参数清单、命令示例与错误处理细节暂未提供。
api-consistency
写作与研究
更新于 10-16 01:14