@aigne/doc-smith 0.8.12-beta.2 → 0.8.12-beta.4

package/docs/guides-publishing-your-docs.zh-TW.md

@@ -0,0 +1,78 @@
+# 發布您的文件
+
+產生文件後，下一步就是將其發布到網路上，讓您的受眾可以存取。本指南將系統性地介紹如何使用 `aigne doc publish` 命令來進行發布流程。
+
+## 發布命令
+
+讓您的文件上線的主要命令是 `aigne doc publish`。此命令會將您產生的檔案上傳到網路服務，以便在瀏覽器中查看。
+
+您可以使用其完整名稱或較短的別名來執行此命令：
+
+```bash
+# 完整命令
+aigne doc publish
+
+# 別名
+aigne doc pub
+aigne doc p
+```
+
+當您首次執行發布命令時，系統會顯示一個互動式提示，讓您選擇偏好的發布平台。
+
+## 發布選項
+
+您有多個選項來託管您的文件。互動式提示將引導您完成選擇。
+
+### 1. DocSmith Cloud (免費託管)
+
+此選項會將您的文件發布到 `docsmith.aigne.io`，這是由 AIGNE 提供的免費託管服務。
+
+-   **使用情境：** 非常適合開源專案、個人部落格，或任何希望在無需自訂基礎設施的情況下實現公開存取的場景。
+-   **成本：** 免費。
+-   **結果：** 成功發布後，您的文件將可透過一個提供的 URL 公開存取。
+
+### 2. 您現有的網站
+
+此選項讓您可以將文件發布到您已擁有並管理的網站。
+
+-   **使用情境：** 最適合將文件直接整合到現有的公司網站、產品網站或個人網域。此方法需要您執行自己的 Discuss Kit 實例。
+-   **成本：** 需要您自己的託管基礎設施。
+-   **設定：**
+    1.  在提示中選擇此選項。
+    2.  系統會要求您輸入網站的 URL (例如：`https://docs.your-company.com`)。
+    3.  若要設定您自己的文件網站，您可以從官方商店取得 Discuss Kit 實例：[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
+
+### 3. 新網站 (付費服務)
+
+如果您沒有現成的網站，此服務可協助您為文件建立一個新的專屬網站。
+
+-   **使用情境：** 適合用於建立一個專業、獨立的文件入口網站，並為您管理自訂網域和託管。
+-   **成本：** 此為付費服務。
+-   **流程：** 此命令將引導您完成部署和設定新 Discuss Kit 實例的必要步驟。如果您之前已開始此流程，您也會看到一個選項來繼續先前的設定。
+
+## 直接發布
+
+對於自動化工作流程 (例如 CI/CD 管線)，或在您完成初始設定後，您可以透過直接指定應用程式 URL 來繞過互動式提示。
+
+使用 `--appUrl` 旗標，並在後面加上您網站的 URL。
+
+```bash
+# 自訂文件網站的範例
+aigne doc publish --appUrl https://docs.your-company.com
+```
+
+一旦您成功發布到特定 URL (無論是透過在提示中選擇選項或使用 `--appUrl` 旗標)，DocSmith 會將此 URL 儲存在您的本機設定中。在後續執行時，它將自動發布到已儲存的 URL，而不會再次詢問。
+
+## 疑難排解
+
+### 授權錯誤
+
+如果您遇到包含「401」或「403」的錯誤訊息，這表示您的驗證權杖無效或已過期。如果權限已變更或權杖過舊，就可能發生這種情況。
+
+要解決此問題，您可以執行 `clear` 命令來清除所有儲存的設定和憑證：
+
+```bash
+aigne doc clear
+```
+
+清除設定後，再次執行 `aigne doc publish`。系統將引導您完成驗證和設定流程，就像第一次執行一樣。

package/docs/guides-publishing-your-docs.zh.md

@@ -0,0 +1,78 @@
+# 发布您的文档
+
+生成文档后，下一步是将其发布到线上，以便您的受众可以访问。本指南系统地概述了使用 `aigne doc publish` 命令的发布过程。
+
+## 发布命令
+
+`aigne doc publish` 是用于上线文档的主要命令。该命令会将您生成的文件上传到 Web 服务，以便在浏览器中查看。
+
+您可以使用其完整名称或更短的别名来执行该命令：
+
+```bash
+# 完整命令
+aigne doc publish
+
+# 别名
+aigne doc pub
+aigne doc p
+```
+
+当您首次运行发布命令时，系统将显示一个交互式提示，让您选择首选的发布平台。
+
+## 发布选项
+
+您有多种托管文档的选项。交互式提示将引导您完成选择。
+
+### 1. DocSmith Cloud（免费托管）
+
+此选项会将您的文档发布到 `docsmith.aigne.io`，这是 AIGNE 提供的免费托管服务。
+
+-   **用例：** 非常适合开源项目、个人博客或任何希望在无需自定义基础设施的情况下实现公开访问的场景。
+-   **成本：** 免费。
+-   **结果：** 您的文档将在发布成功后通过提供的 URL 公开访问。
+
+### 2. 您现有的网站
+
+此选项允许您将文档发布到您已拥有并管理的网站。
+
+-   **用例：** 最适合将文档直接集成到现有公司网站、产品站点或个人域名中。此方法需要您运行自己的 Discuss Kit 实例。
+-   **成本：** 需要您自己的托管基础设施。
+-   **设置：**
+    1.  在提示中选择此选项。
+    2.  系统会要求您输入网站的 URL（例如，`https://docs.your-company.com`）。
+    3.  要设置您自己的文档网站，您可以从官方商店获取 Discuss Kit 实例：[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
+
+### 3. 新网站（付费服务）
+
+如果您没有现有网站，此服务可以帮助您为文档建立一个新的专用站点。
+
+-   **用例：** 适合创建具有自定义域名和托管服务的专业、独立的文档门户。
+-   **成本：** 这是一项付费服务。
+-   **流程：** 该命令将引导您完成部署和配置新的 Discuss Kit 实例所需的步骤。如果您之前已开始此过程，您还会看到一个恢复先前设置的选项。
+
+## 直接发布
+
+对于自动化工作流（如 CI/CD 管道），或在您完成初始设置后，您可以通过直接指定应用程序 URL 来绕过交互式提示。
+
+使用 `--appUrl` 标志，后跟您的网站 URL。
+
+```bash
+# 自定义文档站点示例
+aigne doc publish --appUrl https://docs.your-company.com
+```
+
+当您成功发布到特定 URL（通过在提示中选择选项或使用 `--appUrl` 标志）后，DocSmith 会将此 URL 保存在您的本地配置中。在后续运行中，它将自动发布到已保存的 URL，而不会再次询问。
+
+## 问题排查
+
+### 授权错误
+
+如果您遇到包含“401”或“403”的错误消息，这表示您的身份验证令牌无效或已过期。如果权限已更改或令牌过旧，可能会发生这种情况。
+
+要解决此问题，您可以运行 `clear` 命令来清除所有存储的配置和凭据：
+
+```bash
+aigne doc clear
+```
+
+清除配置后，再次运行 `aigne doc publish`。系统将引导您完成身份验证和设置过程，就像第一次一样。

package/docs/guides-translating-documentation.ja.md

@@ -0,0 +1,95 @@
+# ドキュメントの翻訳
+
+このガイドでは、`aigne doc translate` コマンドを使用して、生成されたドキュメントを複数の言語に翻訳する方法について説明します。このプロセスではAIを利用して、翻訳が文脈を認識し、技術的な正確性を維持するようにします。
+
+このツールは12の言語をサポートしており、世界中のオーディエンスにリーチすることができます。ソースドキュメントの主要言語は、利用可能な翻訳言語のリストから自動的に除外されます。
+
+## `translate` コマンド
+
+`aigne doc translate` コマンドは、既存のドキュメントファイルの翻訳を生成するために使用されます。インタラクティブに実行して、対象のドキュメントと言語を選択することも、コマンドラインフラグを使用してこれらのオプションを直接指定し、ワークフローを自動化することもできます。
+
+### インタラクティブモード
+
+ガイド付きのエクスペリエンスを利用するには、引数なしでコマンドを実行します。
+
+```bash
+aigne doc translate
+```
+
+実行されると、ツールは以下の手順を実行します。
+1.  既存のドキュメントをスキャンします。
+2.  リストから翻訳したい特定のドキュメントを選択するよう促します。
+3.  翻訳の対象言語を選択するよう促します。以前に選択した言語は、便宜上あらかじめチェックされています。
+4.  選択された各ドキュメントと言語のペアについて翻訳プロセスを開始します。
+5.  翻訳されたファイルを、言語ごとに適切なディレクトリに保存します。
+
+### コマンドラインオプション
+
+非インタラクティブな使用やスクリプト作成のために、以下のコマンドラインフラグを使用して翻訳プロセスを制御できます。
+
+<x-field-group>
+  <x-field data-name="--docs" data-type="array<string>">
+    <x-field-desc markdown>翻訳するドキュメントのパスを1つ以上指定します。指定しない場合、ツールはインタラクティブモードに入り、利用可能なドキュメントのリストから選択できるようになります。</x-field-desc>
+  </x-field>
+  <x-field data-name="--langs" data-type="array<string>">
+    <x-field-desc markdown>対象となる言語コード（例：`zh`、`ja`）を1つ以上指定します。省略した場合、インタラクティブに言語を選択するよう促されます。</x-field-desc>
+  </x-field>
+  <x-field data-name="--glossary" data-type="string">
+    <x-field-desc markdown>用語集ファイルへのパス（例：`@path/to/glossary.md`）を提供します。これにより、特定の技術用語がすべてのドキュメントで一貫して翻訳されるようになります。</x-field-desc>
+  </x-field>
+  <x-field data-name="--feedback" data-type="string">
+    <x-field-desc markdown>トーンや用語の調整など、AIの翻訳スタイルをガイドするための具体的な指示やフィードバックを提供します。</x-field-desc>
+  </x-field>
+</x-field-group>
+
+### 使用例
+
+#### 1. 特定のドキュメントを複数の言語に翻訳する
+
+インタラクティブなプロンプトなしで `overview.md` と `examples.md` を中国語（`zh`）と日本語（`ja`）に翻訳するには：
+
+```bash
+aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
+```
+
+#### 2. 用語集を使用して用語の一貫性を保つ
+
+技術用語が正しく翻訳されるように、用語集ファイルを提供します。これは、ブランド名や専門用語の一貫性を維持するのに役立ちます。
+
+```bash
+aigne doc translate --glossary @./glossary.md
+```
+
+#### 3. フィードバックを提供して翻訳スタイルを調整する
+
+フィードバックを提供することで、翻訳スタイルをガイドできます。例えば、よりフォーマルなトーンを要求するには：
+
+```bash
+aigne doc translate --feedback "Use a formal, technical tone for all translations."
+```
+
+このフィードバックは、更新されたドキュメントの履歴に記録されます。
+
+## サポートされている言語
+
+このツールは12言語の翻訳をサポートしています。ドキュメントのネイティブ言語は英語（`en`）です。
+
+| 言語 | コード |
+| :--- | :--- |
+| 中国語（簡体字） | `zh` |
+| 中国語（繁体字）| `zh-TW`|
+| 日本語 | `ja` |
+| 韓国語 | `ko` |
+| スペイン語 | `es` |
+| フランス語 | `fr` |
+| ドイツ語 | `de` |
+| ポルトガル語 | `pt` |
+| ロシア語 | `ru` |
+| イタリア語 | `it` |
+| アラビア語 | `ar` |
+
+## まとめ
+
+`translate` コマンドは、ドキュメントをローカライズするための構造化された方法を提供します。ガイド付き翻訳のためのインタラクティブモードを使用することも、自動化されたワークフローのためのコマンドラインオプションを使用することもできます。用語集やフィードバックなどの機能を使用することで、翻訳されたコンテンツの品質と一貫性を維持するのに役立ちます。
+
+ドキュメントを翻訳した後、[ドキュメントの公開](./guides-publishing-your-docs.md) に進むことができます。

package/docs/guides-translating-documentation.md

@@ -0,0 +1,95 @@
+# Translating Documentation
+
+This guide provides instructions on how to translate your generated documentation into multiple languages using the `aigne doc translate` command. The process uses AI to ensure translations are contextually aware and maintain technical accuracy.
+
+The tool supports 12 languages, allowing you to reach a global audience. The primary language of your source documents will be automatically excluded from the list of available translation languages.
+
+## The `translate` Command
+
+The `aigne doc translate` command is used to generate translations for your existing documentation files. You can run it interactively to select which documents and languages you want, or you can specify these options directly using command-line flags for automated workflows.
+
+### Interactive Mode
+
+For a guided experience, run the command without any arguments:
+
+```bash
+aigne doc translate
+```
+
+When executed, the tool will perform the following steps:
+1.  Scan for existing documents.
+2.  Prompt you to select the specific documents you wish to translate from a list.
+3.  Prompt you to select the target languages for translation. Previously selected languages will be pre-checked for convenience.
+4.  Begin the translation process for each selected document and language pair.
+5.  Save the translated files in the appropriate language-specific directories.
+
+### Command-Line Options
+
+For non-interactive use or scripting, you can use the following command-line flags to control the translation process.
+
+<x-field-group>
+  <x-field data-name="--docs" data-type="array<string>">
+    <x-field-desc markdown>Specify one or more document paths to translate. If not provided, the tool will enter interactive mode to let you select from a list of available documents.</x-field-desc>
+  </x-field>
+  <x-field data-name="--langs" data-type="array<string>">
+    <x-field-desc markdown>Specify one or more target language codes (e.g., `zh`, `ja`). If omitted, you will be prompted to select languages interactively.</x-field-desc>
+  </x-field>
+  <x-field data-name="--glossary" data-type="string">
+    <x-field-desc markdown>Provide a path to a glossary file (e.g., `@path/to/glossary.md`). This ensures that specific technical terms are translated consistently across all documents.</x-field-desc>
+  </x-field>
+  <x-field data-name="--feedback" data-type="string">
+    <x-field-desc markdown>Provide specific instructions or feedback to guide the AI's translation style, such as adjusting the tone or terminology.</x-field-desc>
+  </x-field>
+</x-field-group>
+
+### Usage Examples
+
+#### 1. Translate Specific Documents into Multiple Languages
+
+To translate `overview.md` and `examples.md` into Chinese (`zh`) and Japanese (`ja`) without interactive prompts:
+
+```bash
+aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
+```
+
+#### 2. Use a Glossary for Consistent Terminology
+
+To ensure technical terms are translated correctly, provide a glossary file. This is useful for maintaining consistency for brand names or specialized vocabulary.
+
+```bash
+aigne doc translate --glossary @./glossary.md
+```
+
+#### 3. Provide Feedback to Refine Translation Style
+
+You can guide the translation style by providing feedback. For instance, to request a more formal tone:
+
+```bash
+aigne doc translate --feedback "Use a formal, technical tone for all translations."
+```
+
+This feedback will be recorded in the history for the updated documents.
+
+## Supported Languages
+
+The tool provides translation support for 12 languages. The native language of the documentation is English (`en`).
+
+| Language | Code |
+| :--- | :--- |
+| Chinese (Simplified) | `zh` |
+| Chinese (Traditional)| `zh-TW`|
+| Japanese | `ja` |
+| Korean | `ko` |
+| Spanish | `es` |
+| French | `fr` |
+| German | `de` |
+| Portuguese | `pt` |
+| Russian | `ru` |
+| Italian | `it` |
+| Arabic | `ar` |
+
+## Summary
+
+The `translate` command offers a structured method for localizing your documentation. You can use its interactive mode for guided translations or command-line options for automated workflows. Using features like glossaries and feedback helps maintain the quality and consistency of the translated content.
+
+After translating your documents, you can proceed to [Publishing Your Docs](./guides-publishing-your-docs.md).

package/docs/guides-translating-documentation.zh-TW.md

@@ -0,0 +1,95 @@
+# 翻譯文件
+
+本指南說明如何使用 `aigne doc translate` 指令將您產生的文件翻譯成多種語言。此過程使用 AI 來確保翻譯具有上下文感知能力並保持技術準確性。
+
+該工具支援 12 種語言，讓您能夠觸及全球受眾。您的源文件的主要語言將自動從可用的翻譯語言清單中排除。
+
+## `translate` 指令
+
+`aigne doc translate` 指令用於為您現有的文件檔案產生翻譯。您可以以互動模式執行它，以選擇您想要的文件和語言，或者您也可以使用命令列標誌直接指定這些選項，以實現自動化工作流程。
+
+### 互動模式
+
+若要獲得引導式體驗，請在不帶任何參數的情況下執行該指令：
+
+```bash
+aigne doc translate
+```
+
+執行後，該工具將執行以下步驟：
+1.  掃描現有文件。
+2.  提示您從清單中選擇要翻譯的特定文件。
+3.  提示您選擇目標翻譯語言。為方便起見，先前選擇的語言將被預先勾選。
+4.  為每個選定的文件和語言對開始翻譯過程。
+5.  將翻譯後的文件儲存在相應的特定語言目錄中。
+
+### 命令列選項
+
+對於非互動式使用或腳本編寫，您可以使用以下命令列標誌來控制翻譯過程。
+
+<x-field-group>
+  <x-field data-name="--docs" data-type="array<string>">
+    <x-field-desc markdown>指定一個或多個要翻譯的文件路徑。如果未提供，該工具將進入互動模式，讓您從可用文件清單中選擇。</x-field-desc>
+  </x-field>
+  <x-field data-name="--langs" data-type="array<string>">
+    <x-field-desc markdown>指定一個或多個目標語言代碼（例如，`zh`、`ja`）。如果省略，系統將提示您以互動方式選擇語言。</x-field-desc>
+  </x-field>
+  <x-field data-name="--glossary" data-type="string">
+    <x-field-desc markdown>提供一個詞彙表檔案的路徑（例如，`@path/to/glossary.md`）。這可以確保特定的技術術語在所有文件中得到一致的翻譯。</x-field-desc>
+  </x-field>
+  <x-field data-name="--feedback" data-type="string">
+    <x-field-desc markdown>提供具體的說明或回饋來指導 AI 的翻譯風格，例如調整語氣或術語。</x-field-desc>
+  </x-field>
+</x-field-group>
+
+### 使用範例
+
+#### 1. 將特定文件翻譯成多種語言
+
+要將 `overview.md` 和 `examples.md` 翻譯成中文（`zh`）和日文（`ja`）而無需互動式提示：
+
+```bash
+aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
+```
+
+#### 2. 使用詞彙表以確保術語一致
+
+為確保技術術語翻譯正確，請提供一個詞彙表檔案。這對於保持品牌名稱或專業詞彙的一致性非常有用。
+
+```bash
+aigne doc translate --glossary @./glossary.md
+```
+
+#### 3. 提供回饋以優化翻譯風格
+
+您可以透過提供回饋來指導翻譯風格。例如，若要請求更正式的語氣：
+
+```bash
+aigne doc translate --feedback "Use a formal, technical tone for all translations."
+```
+
+此回饋將記錄在更新文件的歷史記錄中。
+
+## 支援的語言
+
+該工具提供 12 種語言的翻譯支援。文件的原生語言是英文（`en`）。
+
+| 語言 | 代碼 |
+| :--- | :--- |
+| 簡體中文 | `zh` |
+| 繁體中文| `zh-TW`|
+| 日文 | `ja` |
+| 韓文 | `ko` |
+| 西班牙文 | `es` |
+| 法文 | `fr` |
+| 德文 | `de` |
+| 葡萄牙文 | `pt` |
+| 俄文 | `ru` |
+| 義大利文 | `it` |
+| 阿拉伯文 | `ar` |
+
+## 總結
+
+`translate` 指令為您的文件本地化提供了一種結構化的方法。您可以使用其互動模式進行引導式翻譯，或使用命令列選項進行自動化工作流程。使用詞彙表和回饋等功能有助於保持翻譯內容的品質和一致性。
+
+翻譯完文件後，您可以繼續進行[發布您的文件](./guides-publishing-your-docs.md)。

package/docs/guides-translating-documentation.zh.md

@@ -0,0 +1,95 @@
+# 翻译文档
+
+本指南介绍了如何使用 `aigne doc translate` 命令将您生成的文档翻译成多种语言。该过程使用 AI 来确保翻译能够感知上下文并保持技术准确性。
+
+该工具支持 12 种语言，使您能够触达全球受众。您源文档的主要语言将自动从可用翻译语言列表中排除。
+
+## `translate` 命令
+
+`aigne doc translate` 命令用于为您现有的文档文件生成翻译。您可以以交互方式运行它来选择您想要的文档和语言，也可以使用命令行标志直接指定这些选项以实现自动化工作流。
+
+### 交互模式
+
+若需引导式体验，请不带任何参数运行该命令：
+
+```bash
+aigne doc translate
+```
+
+执行后，该工具将执行以下步骤：
+1.  扫描现有文档。
+2.  提示您从列表中选择希望翻译的特定文档。
+3.  提示您选择目标翻译语言。为方便起见，先前选择的语言将被预先选中。
+4.  为每个选定的文档和语言对开始翻译过程。
+5.  将翻译后的文件保存在相应的特定语言目录中。
+
+### 命令行选项
+
+对于非交互式使用或编写脚本，您可以使用以下命令行标志来控制翻译过程。
+
+<x-field-group>
+  <x-field data-name="--docs" data-type="array<string>">
+    <x-field-desc markdown>指定一个或多个要翻译的文档路径。如果未提供，该工具将进入交互模式，让您从可用文档列表中进行选择。</x-field-desc>
+  </x-field>
+  <x-field data-name="--langs" data-type="array<string>">
+    <x-field-desc markdown>指定一个或多个目标语言代码（例如，`zh`、`ja`）。如果省略，系统将提示您以交互方式选择语言。</x-field-desc>
+  </x-field>
+  <x-field data-name="--glossary" data-type="string">
+    <x-field-desc markdown>提供词汇表文件的路径（例如，`@path/to/glossary.md`）。这可确保特定技术术语在所有文档中得到一致的翻译。</x-field-desc>
+  </x-field>
+  <x-field data-name="--feedback" data-type="string">
+    <x-field-desc markdown>提供具体的说明或反馈来指导 AI 的翻译风格，例如调整语气或术语。</x-field-desc>
+  </x-field>
+</x-field-group>
+
+### 用法示例
+
+#### 1. 将特定文档翻译成多种语言
+
+要将 `overview.md` 和 `examples.md` 翻译成中文（`zh`）和日文（`ja`）且无需交互式提示：
+
+```bash
+aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
+```
+
+#### 2. 使用词汇表以确保术语一致
+
+为确保技术术语翻译正确，请提供一个词汇表文件。这对于保持品牌名称或专业词汇的一致性非常有用。
+
+```bash
+aigne doc translate --glossary @./glossary.md
+```
+
+#### 3. 提供反馈以优化翻译风格
+
+您可以通过提供反馈来指导翻译风格。例如，要请求更正式的语气：
+
+```bash
+aigne doc translate --feedback "Use a formal, technical tone for all translations."
+```
+
+此反馈将被记录在更新后文档的历史记录中。
+
+## 支持的语言
+
+该工具提供 12 种语言的翻译支持。文档的母语是英语（`en`）。
+
+| 语言 | 代码 |
+| :--- | :--- |
+| 中文（简体） | `zh` |
+| 中文（繁体）| `zh-TW`|
+| 日语 | `ja` |
+| 韩语 | `ko` |
+| 西班牙语 | `es` |
+| 法语 | `fr` |
+| 德语 | `de` |
+| 葡萄牙语 | `pt` |
+| 俄语 | `ru` |
+| 意大利语 | `it` |
+| 阿拉伯语 | `ar` |
+
+## 总结
+
+`translate` 命令为本地化您的文档提供了一种结构化的方法。您可以使用其交互模式进行引导式翻译，或使用命令行选项实现自动化工作流。使用词汇表和反馈等功能有助于保持翻译内容的质量和一致性。
+
+翻译完文档后，您可以继续[发布您的文档](./guides-publishing-your-docs.md)。

package/docs/guides-updating-documentation.ja.md

@@ -0,0 +1,77 @@
+# ドキュメントの更新
+
+ドキュメントの正確性と関連性を維持することは、継続的なプロセスです。コードベースが進化したり、新しいフィードバックを受け取ったりするにつれて、既存のドキュメントを修正する必要があります。`update` コマンドは、新しい指示で特定のドキュメントを再生成するための構造化された方法を提供し、ドキュメントが常に最新の状態に保たれるようにします。
+
+このガイドでは、ドキュメントを更新するための2つの主要な方法について説明します。1つは、詳細な単一ドキュメントの改良のためのインタラクティブモード、もう1つは、一度に複数のドキュメントに変更を適用するためのバッチモードです。
+
+## 2つの操作モード
+
+`update` コマンドは、選択したドキュメントの数と指定したオプションに応じて、2つのモードのいずれかで動作します。
+
+1.  **インタラクティブモード**：`--reset` フラグなしで単一のドキュメントを更新する際にトリガーされます。このモードは、フィードバックを提供し、変更を確認し、ドキュメントが基準を満たすまでプロセスを繰り返すことができる、反復的な改良のために設計されています。
+2.  **バッチモード**：複数のドキュメントを同時に更新する場合、または `--reset` フラグを使用する場合に使用されます。このモードは、フィードバックをすべての選択されたドキュメントに一度の操作で適用するため、広範な変更に効率的です。
+
+## インタラクティブモード：単一ドキュメントの改良
+
+インタラクティブモードは、単一のドキュメントに正確な変更を加えるための管理された環境を提供します。特定のフィードバックに基づいてコンテンツを慎重に確認し、調整する必要がある場合に最適な選択肢です。
+
+インタラクティブセッションを開始するには、`aigne doc update` コマンドを実行し、リストから単一のドキュメントを選択します。
+
+```bash
+aigne doc update
+```
+
+ツールは以下の手順を案内します：
+
+1.  **ドキュメント分析**：システムはまず、選択されたドキュメントの構造的なアウトラインを表示し、その主要な見出しを示します。
+2.  **ユーザーアクション**：次に、3つのアクションから1つを選択するよう求められます：
+    *   **ドキュメントを表示**：ドキュメントの現在のバージョンの全内容をターミナルにレンダリングして表示し、簡単に読めるようにします。
+    *   **フィードバックを提供**：「エラーハンドリングに関するセクションを追加してください」から「`config` オブジェクトの目的を明確にしてください」まで、変更リクエストを入力するよう求められます。
+    *   **完了**：インタラクティブセッションを終了し、最後に生成されたバージョンのドキュメントを保存します。
+3.  **コンテンツの再生成**：フィードバックを送信すると、AIがあなたの指示に基づいてドキュメントのコンテンツを再生成します。その後、新しい見出し構造が表示されます。
+4.  **反復または終了**：結果に満足するまで、表示、フィードバック提供、再生成のこのループを続けることができます。「完了」を選択すると、プロセスは完了です。
+
+この反復的なサイクルにより、最終的な出力に対してきめ細かな制御が可能になり、更新されたドキュメントが正確で完全なものになることが保証されます。
+
+## バッチモード：複数ドキュメントの更新
+
+バッチモードは、同じ一般的なフィードバックを複数のドキュメントに適用したり、それらを完全に再生成したりする必要がある場合に効率的に設計されています。このモードは、複数のドキュメントを選択した場合や、`--docs` や `--reset` のようなコマンドラインフラグを使用した場合に自動的に有効になります。
+
+### 特定のフィードバックによる更新
+
+インタラクティブセッションに入ることなく、コマンドラインから直接フィードバックを提供して、1つ以上のドキュメントを更新できます。
+
+```bash title="フィードバックを付けて単一のドキュメントを更新"
+aigne doc update --docs /guides/overview.md --feedback "Add a section explaining the authentication flow"
+```
+
+```bash title="同じフィードバックで複数のドキュメントを更新"
+aigne doc update --docs /guides/overview.md --docs /guides/getting-started.md --feedback "Improve the clarity of all code examples"
+```
+
+### リセットと再生成
+
+`--reset` フラグは、ドキュメントの以前のバージョンを無視し、ソースコードに基づいて最初から再生成するようにツールに指示します。これは、コードの大幅な変更により既存のドキュメントが陳腐化した場合に便利です。
+
+```bash title="特定のドキュメントを最初から再生成"
+aigne doc update --docs /guides/overview.md --reset
+```
+
+## コマンドリファレンス
+
+`update` コマンドは、その動作を制御するためにいくつかのフラグを受け入れます。
+
+| パラメータ | 説明 | 例 |
+| :--- | :--- | :--- |
+| `--docs <path>` | 更新する1つ以上のドキュメントパスを指定します。複数回使用できます。 | `--docs /overview --docs /guides/generating-documentation` |
+| `--feedback <text>` | コンテンツの変更点を指示します。 | `--feedback "Add more detail to the installation steps"` |
+| `--glossary <file>` | 再生成時に一貫した用語を確保するために、用語集ファイルを指定します。 | `--glossary @/path/to/glossary.md` |
+| `--reset` | 選択したドキュメントの以前のバージョンを無視して、完全な再生成を強制するブール値フラグ。 | `--reset` |
+
+## まとめ
+
+`update` コマンドは、ドキュメントをプロジェクトと整合性を保つための柔軟なワークフローを提供します。単一ドキュメントの詳細な反復的な変更にはインタラクティブモードを使用し、複数のファイルにわたる広範な更新を効率的に適用するにはバッチモードを使用してください。
+
+関連タスクについては、以下のガイドを参照してください：
+- [ドキュメントの生成](./guides-generating-documentation.md)
+- [ドキュメントの翻訳](./guides-translating-documentation.md)