跨语言接口文档先建立字段定义,记录名称、类型、单位、范围、空值与缺失值的含义。区分协议使用的标识和面向读者的说明。除非接口定义允许,不把字段标识、枚举值或错误码随自然语言翻译改变。

为变更保存版本与对应关系

参数含义、默认值、错误处理或结构发生变化时,记录接口版本及迁移规则。各语言资料关联同一版本,注明尚未更新的部分。保存原定义、修订内容和相关示例,避免新旧说明混用。

示例需要按实际接口检查

在约定环境中解析请求与响应,核对字段、数值和错误分支。使用固定标识关联各语言错误说明,检查缺失参数、非法值及不支持版本的处理。翻译后的示例只有在完成对应检查后才能记为已验证。

同时检查语言和文字方向

W3C国际化指导说明讨论自然语言消息的语言及文字方向信息。文档需要区分可读说明与程序标识,并检查双向文本、代码片段和数字的呈现。保存渲染与解析结果,不将排版可读替代协议功能验证。

参见W3C国际化指导说明。