API仕様書

定義

ソフトウェアの外部インタフェースを説明する文書。

訳し分け・誤訳の注意

「API文档」。関数名、パラメータ名、型は訳さない。説明文のみ訳す。ここを訳すと動かなくなる。

実務での出現場面

ソフトウェア製品の技術資料、統合の手順、サンプルコードの説明に現れます。関数名、パラメータ名、型は識別子であり訳しません。説明文のみが翻訳の対象です。戻り値とエラーコードの一覧が中核であり、コードは転記、説明のみ翻訳という分担になります。サンプルコード中のコメントは訳します。

実際に起きる失敗

パラメータ名を訳した API 資料があり、そのとおりに実装したコードが動きませんでした。識別子は転記の対象であり、翻訳の対象ではありません。

対訳の実例

本 API は認証トークンを必要とします。／ 本 API 需要认证令牌。

本ページは技術文書の翻訳実務にもとづく用語の対応関係を示すものです。 法令上の定義や適用範囲を示すものではありません。