情報ファイルに関するサードパーティ開発者向けドキュメント

docs/サードパーティ開発者の方へ.md

@@ -14,13 +14,16 @@ VOICEVOXのエンジンを使用するためには、APIを用いる必要があ
 
 ### APIのアクセス先について
 
-従来は、エンジン毎に通信ポート番号が固定されていました。たとえば、VOICEVOXエンジンであれば 50021 といった感じです。しかし、現在のエンジンはポート番号の競合に伴う起動エラーを避けるため、起動するタイミングで通信ポートの番号を動的に決めるようになっています。
+HTTP経由でAPIにアクセスできます。
 
-以上のことから、アクセスするべきエンジンポートが 50021 ではない可能性があります。サードパーティツールは、やみくもにエンドポイントを仮定してアクセスするのではなく、最初に「情報ファイル」を参照してAPIのエンドポイントを特定してください。
+* VOICEVOXエンジンがデフォルトで使用するポート番号は、内部で決まっています（例：50021/tcp）。
+* 他のアプリケーションがポート番号を使用している場合、競合が発生するため別のポートを開きます。
+* 最終的に開いたポート番号については、情報ファイルを参照して特定してください。
+* 動的に番号が変更されるのは、VOICEVOX v0.16以降の機能です。
 
 ### ランタイム情報ファイル（以下情報ファイル）について
 
-そのため、サードパーティがエンジンの通信ポートを特定するために「情報ファイル」というものが生成されるようになっています。サードパーティでアプリケーションを作る製作者は、まずはこのファイルを参照してアクセス先を決定してください。
+サードパーティが必要な情報を手に入れるために、「情報ファイル」というものが生成されるようになっています。サードパーティの製作者は、まずはこのファイルを参照してアクセス先を決定してください。
 
 また、VOICEVOX内でエンジンが再起動した場合に、通信ポート番号が変わる可能性があります。サードパーティ側でAPI使用中に突如通信失敗が発生した場合は、このファイルが更新されているか確認するようにしてください。
 
@@ -37,7 +40,7 @@ VOICEVOXのエンジンを使用するためには、APIを用いる必要があ
 |Windows         |C:\Users\（ユーザー名）\AppData\Roaming\voicevox\runtime-info.json           |
 |MacOS           |/Users/（ユーザー名）/Library/Application Support/voicevox/runtime-info.json |
 
-なお、Windows のインストール状況やプロファイル設定次第では、上記ファイルの配置が変更されることがあります。確実に場所を特定するためには、環境変数 ``LOCALAPPDATA`` を用いて、Roamingフォルダの位置を特定してください。
+なお、Windows のプロファイル設定次第では、上記ファイルの配置が変更されることがあります。確実に場所を特定するためには、環境変数 ``APPDATA`` を用いて、Roamingフォルダの位置を特定してください。
 
 ### ファイルの中身と意味
 
@@ -76,3 +79,4 @@ VOICEVOXのエンジンを使用するためには、APIを用いる必要があ
 
 * エンジンが起動（もしくは再起動）するタイミングでファイルが生成、更新されます。
 * 何らかの理由でファイルの書き込み権が取得できなかった場合には更新されません。（更新のタイミングで他ツールがファイルを開いていた場合など）
+* この生成タイミングはファイルバージョン１の実装であり、開発の過程で変更される可能性があります。