feat: add note for api name

Signed-off-by: Takagi, Isamu <[email protected]>
tier4 · Nov 28, 2024 · 3b184e8 · 3b184e8
1 parent 0cb50af
commit 3b184e8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/design/autoware-interfaces/prototyping/index.md b/docs/design/autoware-interfaces/prototyping/index.md
@@ -1,5 +1,9 @@
 # List of TIER IV API
 
+!!! note
+
+    歴史的な経緯により、TIER IV API は High-level API または TIER IV External API と呼ばれることがあります。
+
 ## Deprecated API
 
 これらの API は TIER IV の独自実装であり、段階的に [AD API](../ad-api/list/index.md) に統合する予定です。

diff --git a/docs/design/autoware-interfaces/prototyping/migration/operation-mode.md b/docs/design/autoware-interfaces/prototyping/migration/operation-mode.md
@@ -1,9 +1,13 @@
 # Operation mode compatibility
 
+!!! note
+
+    歴史的な経緯により、TIER IV API は High-level API または TIER IV External API と呼ばれることがあります。
+
 ## 構成（TIER IV API）
 
-TIER IV API は、以下のような２つの入力セレクター（operator と observer）と、２つのフィルター（pause_driving と engage）からなる構成に基づいて設計されました。
-フィルターの engage は車両の直接操作時（DRIVER）以外では常に適用され false の場合にコマンドを停止で上書きする効果を持ちます。
+TIER IV API における Operation Mode は、以下のような２つの入力セレクター（operator と observer）と、２つのフィルター（pause_driving と engage）からなる構成に基づいて設計されました。
+Engage フィルターは車両の直接操作時（DRIVER）以外では常に適用され false の場合にコマンドを停止で上書きする効果を持ちます。
 もう一方のフィルターの pause_driving は AUTONOMOUS のみが対象で true の場合に車両の最高速度を 0 km/h に設定することで車両を停止させていました。
 
 ![block-tier4](./operation-mode/block-tier4.drawio.svg)