跨語言接口文檔先建立字段定義,記錄名稱、類型、單位、範圍、空值與缺失值的含義。區分協議使用的標識和麵向讀者的說明。除非接口定義允許,不把字段標識、枚舉值或錯誤碼隨自然語言翻譯改變。
為變更保存版本與對應關係
參數含義、默認值、錯誤處理或結構發生變化時,記錄接口版本及遷移規則。各語言資料關聯同一版本,註明尚未更新的部分。保存原定義、修訂內容和相關示例,避免新舊說明混用。
示例需要按實際接口檢查
在約定環境中解析請求與響應,核對字段、數值和錯誤分支。使用固定標識關聯各語言錯誤說明,檢查缺失參數、非法值及不支持版本的處理。翻譯後的示例只有在完成對應檢查後才能記為已驗證。
同時檢查語言和文字方向
W3C國際化指導說明討論自然語言消息的語言及文字方向信息。文檔需要區分可讀說明與程序標識,並檢查雙向文本、代碼片段和數字的呈現。保存渲染與解析結果,不將排版可讀替代協議功能驗證。
參見W3C國際化指導說明。