From 8de2b4997475e7940c9ba0c15f73e91a210cce11 Mon Sep 17 00:00:00 2001
From: Miwa <63481257+ensan-hcl@users.noreply.github.com>
Date: Wed, 4 Jun 2025 09:37:26 +0900
Subject: [PATCH] docs: add learning data guide

---
 Docs/README.md        |  1 +
 Docs/learning_data.md | 30 ++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 Docs/learning_data.md

diff --git a/Docs/README.md b/Docs/README.md
index 51b061d..850142a 100644
--- a/Docs/README.md
+++ b/Docs/README.md
@@ -5,4 +5,5 @@
 azooKey本体については[azooKey/docs](https://github.com/ensan-hcl/azooKey/tree/develop/docs/overview.md)をご覧ください。
 
 開発ガイドは[development_guide.md](./development_guide.md)をご覧ください。
+学習データの保存先やリセット方法については[learning_data.md](./learning_data.md)を参照してください。
 
diff --git a/Docs/learning_data.md b/Docs/learning_data.md
new file mode 100644
index 0000000..a463c9d
--- /dev/null
+++ b/Docs/learning_data.md
@@ -0,0 +1,30 @@
+# 学習データについて
+
+AzooKeyKanaKanjiConverter では、ユーザが変換候補を選択した結果を学習して、次回以降の変換候補の並び替えに利用します。学習結果は `memoryDirectoryURL` で指定したディレクトリに保存されます。
+
+## 保存されるファイル
+
+学習データは内部的に辞書形式のファイルとして保持されます。主なファイルは以下の通りです。
+
+- `memory.louds`
+- `memory.loudschars2`
+- `memory.loudstxt3`
+
+更新時には一時的に `.2` の拡張子が付いたファイルを作成し、安全に置き換える仕組みになっています。更新処理の詳細は [conversion_algorithms.md](./conversion_algorithms.md) を参照してください。
+
+## ディレクトリの指定
+
+`ConvertRequestOptions` の `memoryDirectoryURL` に書き込み可能なディレクトリを指定してください。通常はアプリの書類フォルダなどを指定します。英語用と日本語用など、キーボードのターゲットごとに学習データを分けたい場合は、言語ごとに別のディレクトリを指定してください。
+
+```swift
+let options = ConvertRequestOptions.withDefaultDictionary(
+    keyboardLanguage: .ja_JP,
+    learningType: .temporary,
+    memoryDirectoryURL: .documentsDirectory,
+    sharedContainerURL: .documentsDirectory
+)
+```
+
+## 学習データのリセット
+
+変換候補の長押しから個別に学習をリセットできます。ディレクトリを削除することで全ての学習内容を消去することも可能です。