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

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

@@ -0,0 +1,149 @@
+# ドキュメントの生成
+
+このガイドでは、プロジェクトのソースファイルからドキュメント一式を作成するための体系的な手順を説明します。このプロセスは `aigne doc generate` コマンドを使用して開始されます。このコマンドはコードベースを分析し、論理的な構造を提案し、各ドキュメントのコンテンツを作成します。
+
+このコマンドは、ドキュメントを最初に作成するための主要なツールです。作成後のドキュメントの修正については、[ドキュメントの更新](./guides-updating-documentation.md)ガイドを参照してください。
+
+### 生成のワークフロー
+
+`generate` コマンドは、ドキュメントを構築するための一連の自動化されたステップを実行します。このプロセスは対話形式で設計されており、コンテンツが書き込まれる前に提案された構造を確認し、承認することができます。
+
+```d2
+direction: down
+
+start: {
+  label: "開始"
+  shape: oval
+}
+
+run_command: {
+  label: "'aigne doc generate' を実行"
+  shape: rectangle
+}
+
+check_config: {
+  label: "設定ファイルが存在するか？"
+  shape: diamond
+}
+
+interactive_setup: {
+  label: "対話型セットアップのガイド"
+  shape: rectangle
+  tooltip: ".aigne/doc-smith/config.yaml が見つからない場合、対話型セットアップがトリガーされます。"
+}
+
+propose_structure: {
+  label: "プロジェクトを分析し、ドキュメント構造を提案"
+  shape: rectangle
+}
+
+review_structure: {
+  label: "ユーザーが提案された構造を確認"
+  shape: rectangle
+}
+
+user_approve: {
+  label: "構造を承認しますか？"
+  shape: diamond
+}
+
+provide_feedback: {
+  label: "構造を改善するためのフィードバックを提供"
+  shape: rectangle
+  tooltip: "ユーザーは、セクションの名前の変更、追加、削除などの変更を要求できます。"
+}
+
+generate_content: {
+  label: "すべてのドキュメントのコンテンツを生成"
+  shape: rectangle
+}
+
+end: {
+  label: "終了"
+  shape: oval
+}
+
+start -> run_command
+run_command -> check_config
+check_config -> interactive_setup: {
+  label: "いいえ"
+}
+interactive_setup -> propose_structure
+check_config -> propose_structure: {
+  label: "はい"
+}
+propose_structure -> review_structure
+review_structure -> user_approve
+user_approve -> provide_feedback: {
+  label: "いいえ"
+}
+provide_feedback -> review_structure
+user_approve -> generate_content: {
+  label: "はい"
+}
+generate_content -> end
+```
+
+## ステップバイステップのプロセス
+
+ドキュメントを生成するには、ターミナルでプロジェクトのルートディレクトリに移動し、以下の手順に従ってください。
+
+### 1. Generate コマンドの実行
+
+`generate` コマンドを実行してプロセスを開始します。ツールはプロジェクトのファイルと構造の分析から開始します。
+
+```bash 基本的な生成コマンド
+aigne doc generate
+```
+
+簡潔にするために、エイリアス `gen` または `g` を使用することもできます。
+
+### 2. ドキュメント構造の確認
+
+分析が完了すると、ツールは提案されたドキュメント構造を提示します。この構造は、作成されるドキュメントの階層的な計画です。
+
+この計画を確認するよう求められます。
+
+```
+ドキュメントの構造を最適化しますか？
+タイトルを編集したり、セクションを再編成したりできます。
+❯ 問題ありません - 現在の構造で続行します
+  はい、構造を最適化します
+```
+
+-   **問題ありません - 現在の構造で続行します**: このオプションを選択すると、提案された構造を承認し、直接コンテンツ生成に進みます。
+-   **はい、構造を最適化します**: このオプションは、計画を修正したい場合に選択します。プレーンテキストで、「'API' を 'API リファレンス' に変更」や「'デプロイ' のための新しいセクションを追加」などのフィードバックを提供できます。AI はあなたのフィードバックに基づいて構造を修正し、再度確認することができます。このサイクルは、構造があなたの要件を満たすまで繰り返すことができます。
+
+### 3. コンテンツの生成
+
+ドキュメント構造が承認されると、DocSmith は計画内の各ドキュメントの詳細なコンテンツの生成を開始します。このプロセスは自動的に実行され、その所要時間はプロジェクトの規模と複雑さによって異なります。
+
+完了すると、生成されたファイルは設定で指定された出力ディレクトリ（例：`./docs`）に保存されます。
+
+## コマンドのパラメータ
+
+`generate` コマンドは、その動作を制御するためのいくつかのオプションパラメータを受け入れます。
+
+| パラメータ          | 説明                                                                                                                                     | 例                                                                                  |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `--forceRegenerate` | 既存の構造やコンテンツをすべて無視して、すべてのドキュメントをゼロから再構築します。これは、白紙の状態からやり直す場合に便利です。             | `aigne doc generate --forceRegenerate`                                              |
+| `--feedback`        | 構造生成フェーズで AI をガイドするための初期指示を提供します。                                                                             | `aigne doc generate --feedback "API の例を増やし、トラブルシューティングのセクションを追加してください"` |
+| `--glossary`        | ドキュメント全体で一貫した用語の使用を保証するために、用語集ファイル（`.md`）を指定します。                                                  | `aigne doc generate --glossary @/path/to/glossary.md`                             |
+
+### 例：完全な再構築を強制する
+
+以前に生成されたすべてのドキュメントを破棄し、コードの現在の状態に基づいて新しいセットを作成したい場合は、`--forceRegenerate` フラグを使用します。
+
+```bash 再生成の強制
+aigne doc generate --forceRegenerate
+```
+
+## まとめ
+
+`generate` コマンドは、初期プロジェクトドキュメントを作成するプロセス全体を統括します。自動化されたコード分析と対話的なレビュープロセスを組み合わせることで、構造化された関連性の高いドキュメント一式を生成します。
+
+ドキュメントが生成された後、次のことを行うことができます。
+
+-   [ドキュメントの更新](./guides-updating-documentation.md): 特定のドキュメントに変更を加える。
+-   [ドキュメントの翻訳](./guides-translating-documentation.md): コンテンツを他の言語に翻訳する。
+-   [ドキュメントの公開](./guides-publishing-your-docs.md): ドキュメントをオンラインで利用可能にする。

package/docs/guides-generating-documentation.md

@@ -0,0 +1,149 @@
+# Generating Documentation
+
+This guide provides a systematic procedure for creating a complete set of documentation from your project's source files. The process is initiated using the `aigne doc generate` command, which analyzes your codebase, proposes a logical structure, and then writes the content for each document.
+
+This command is the primary tool for the initial creation of your documentation. For modifying documents after they have been created, refer to the [Updating Documentation](./guides-updating-documentation.md) guide.
+
+### The Generation Workflow
+
+The `generate` command executes a sequence of automated steps to build your documentation. The process is designed to be interactive, allowing you to review and approve the proposed structure before content is written.
+
+```d2
+direction: down
+
+start: {
+  label: "Start"
+  shape: oval
+}
+
+run_command: {
+  label: "Run 'aigne doc generate'"
+  shape: rectangle
+}
+
+check_config: {
+  label: "Configuration file exists?"
+  shape: diamond
+}
+
+interactive_setup: {
+  label: "Guide through interactive setup"
+  shape: rectangle
+  tooltip: "If .aigne/doc-smith/config.yaml is not found, an interactive setup is triggered."
+}
+
+propose_structure: {
+  label: "Analyze project and propose document structure"
+  shape: rectangle
+}
+
+review_structure: {
+  label: "User reviews the proposed structure"
+  shape: rectangle
+}
+
+user_approve: {
+  label: "Approve structure?"
+  shape: diamond
+}
+
+provide_feedback: {
+  label: "Provide feedback to refine structure"
+  shape: rectangle
+  tooltip: "User can request changes like renaming, adding, or removing sections."
+}
+
+generate_content: {
+  label: "Generate content for all documents"
+  shape: rectangle
+}
+
+end: {
+  label: "End"
+  shape: oval
+}
+
+start -> run_command
+run_command -> check_config
+check_config -> interactive_setup: {
+  label: "No"
+}
+interactive_setup -> propose_structure
+check_config -> propose_structure: {
+  label: "Yes"
+}
+propose_structure -> review_structure
+review_structure -> user_approve
+user_approve -> provide_feedback: {
+  label: "No"
+}
+provide_feedback -> review_structure
+user_approve -> generate_content: {
+  label: "Yes"
+}
+generate_content -> end
+```
+
+## Step-by-Step Process
+
+To generate your documentation, navigate to the root directory of your project in your terminal and follow these steps.
+
+### 1. Run the Generate Command
+
+Execute the `generate` command to begin the process. The tool will start by analyzing your project's files and structure.
+
+```bash Basic Generation Command
+aigne doc generate
+```
+
+You can also use the aliases `gen` or `g` for brevity.
+
+### 2. Review the Documentation Structure
+
+After the analysis is complete, the tool will present a proposed documentation structure. This structure is a hierarchical plan of the documents that will be created.
+
+You will be prompted to review this plan:
+
+```
+Would you like to optimize the documentation structure?
+You can edit titles, reorganize sections.
+❯ Looks good - proceed with current structure
+  Yes, optimize the structure
+```
+
+-   **Looks good - proceed with current structure**: Select this option to approve the proposed structure and proceed directly to content generation.
+-   **Yes, optimize the structure**: Select this option if you wish to modify the plan. You will be able to provide feedback in plain text, such as "Rename 'API' to 'API Reference'" or "Add a new section for 'Deployment'." The AI will revise the structure based on your feedback, and you can review it again. This cycle can be repeated until the structure meets your requirements.
+
+### 3. Content Generation
+
+Once the documentation structure is approved, DocSmith will begin generating the detailed content for each document in the plan. This process runs automatically, and its duration depends on the size and complexity of your project.
+
+Upon completion, the generated files will be saved to the output directory specified in your configuration (e.g., `./docs`).
+
+## Command Parameters
+
+The `generate` command accepts several optional parameters to control its behavior.
+
+| Parameter           | Description                                                                                                                              | Example                                                                     |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `--forceRegenerate` | Rebuilds all documentation from scratch, ignoring any existing structure or content. This is useful for starting over with a clean slate. | `aigne doc generate --forceRegenerate`                                        |
+| `--feedback`        | Provides initial instructions to guide the AI during the structure generation phase.                                                     | `aigne doc generate --feedback "Add more API examples and a troubleshooting section"` |
+| `--glossary`        | Specifies a glossary file (`.md`) to ensure consistent use of terminology throughout the documentation.                                   | `aigne doc generate --glossary @/path/to/glossary.md`                       |
+
+### Example: Forcing a Complete Rebuild
+
+If you want to discard all previously generated documents and create a new set based on the current state of your code, use the `--forceRegenerate` flag.
+
+```bash Forcing Regeneration
+aigne doc generate --forceRegenerate
+```
+
+## Summary
+
+The `generate` command orchestrates the entire process of creating your initial project documentation. It combines automated code analysis with an interactive review process to produce a structured and relevant set of documents.
+
+After your documents are generated, you may want to:
+
+-   [Update Documentation](./guides-updating-documentation.md): Make changes to specific documents.
+-   [Translate Documentation](./guides-translating-documentation.md): Translate your content into other languages.
+-   [Publishing Your Docs](./guides-publishing-your-docs.md): Make your documentation available online.

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

@@ -0,0 +1,149 @@
+# 產生文件
+
+本指南提供了一套系統化程序，說明如何從專案的原始檔案建立完整文件。此流程使用 `aigne doc generate` 命令啟動，該命令會分析您的程式碼庫、提出邏輯結構，然後為每份文件撰寫內容。
+
+此命令是初次建立您文件的主要工具。若要在文件建立後進行修改，請參閱 [更新文件](./guides-updating-documentation.md) 指南。
+
+### 產生工作流程
+
+`generate` 命令會執行一系列自動化步驟來建立您的文件。此過程設計為互動式，讓您能在內容寫入前，審查並核准建議的結構。
+
+```d2
+direction: down
+
+start: {
+  label: "開始"
+  shape: oval
+}
+
+run_command: {
+  label: "執行 'aigne doc generate'"
+  shape: rectangle
+}
+
+check_config: {
+  label: "設定檔是否存在？"
+  shape: diamond
+}
+
+interactive_setup: {
+  label: "引導進行互動式設定"
+  shape: rectangle
+  tooltip: "若找不到 .aigne/doc-smith/config.yaml，將觸發互動式設定。"
+}
+
+propose_structure: {
+  label: "分析專案並提出文件結構"
+  shape: rectangle
+}
+
+review_structure: {
+  label: "使用者審查建議的結構"
+  shape: rectangle
+}
+
+user_approve: {
+  label: "核准結構？"
+  shape: diamond
+}
+
+provide_feedback: {
+  label: "提供回饋以完善結構"
+  shape: rectangle
+  tooltip: "使用者可以要求變更，例如重新命名、新增或移除章節。"
+}
+
+generate_content: {
+  label: "為所有文件產生內容"
+  shape: rectangle
+}
+
+end: {
+  label: "結束"
+  shape: oval
+}
+
+start -> run_command
+run_command -> check_config
+check_config -> interactive_setup: {
+  label: "否"
+}
+interactive_setup -> propose_structure
+check_config -> propose_structure: {
+  label: "是"
+}
+propose_structure -> review_structure
+review_structure -> user_approve
+user_approve -> provide_feedback: {
+  label: "否"
+}
+provide_feedback -> review_structure
+user_approve -> generate_content: {
+  label: "是"
+}
+generate_content -> end
+```
+
+## 逐步流程
+
+若要產生您的文件，請在您的終端機中導覽至專案的根目錄，並遵循以下步驟。
+
+### 1. 執行 Generate 命令
+
+執行 `generate` 命令以開始此流程。該工具將首先分析您專案的檔案和結構。
+
+```bash 基本產生命令
+aigne doc generate
+```
+
+您也可以使用別名 `gen` 或 `g` 以求簡潔。
+
+### 2. 審查文件結構
+
+分析完成後，該工具將呈現一個建議的文件結構。此結構是將要建立的各份文件的一個階層式規劃。
+
+系統會提示您審查此計畫：
+
+```
+您想最佳化文件結構嗎？
+您可以編輯標題、重組章節。
+❯ 看起來不錯 - 繼續使用目前結構
+  是，最佳化結構
+```
+
+-   **看起來不錯 - 繼續使用目前結構**：選擇此選項以核准建議的結構，並直接進入內容產生階段。
+-   **是，最佳化結構**：如果您希望修改計畫，請選擇此選項。您將能夠以純文字形式提供回饋，例如「將『API』重新命名為『API 參考』」或「新增一個『部署』的章節」。AI 將根據您的回饋修訂結構，您可以再次審查。此循環可以重複進行，直到結構符合您的要求。
+
+### 3. 內容產生
+
+文件結構一經核准，DocSmith 將開始為計畫中的每份文件產生詳細內容。此過程會自動執行，其持續時間取決於您專案的規模與複雜度。
+
+完成後，產生的檔案將儲存至您設定中指定的輸出目錄（例如 `./docs`）。
+
+## 命令參數
+
+`generate` 命令接受數個可選參數來控制其行為。
+
+| 參數 | 說明 | 範例 |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `--forceRegenerate` | 從頭開始重建所有文件，忽略任何現有的結構或內容。這在您想從頭開始時很有用。 | `aigne doc generate --forceRegenerate` |
+| `--feedback` | 提供初始指令，以在結構產生階段指導 AI。 | `aigne doc generate --feedback "新增更多 API 範例和疑難排解章節"` |
+| `--glossary` | 指定一個詞彙表檔案（`.md`），以確保在整個文件中術語使用的一致性。 | `aigne doc generate --glossary @/path/to/glossary.md` |
+
+### 範例：強制完全重建
+
+如果您想捨棄所有先前產生的文件，並根據您程式碼的目前狀態建立一套新的文件，請使用 `--forceRegenerate` 旗標。
+
+```bash 強制重新產生
+aigne doc generate --forceRegenerate
+```
+
+## 總結
+
+`generate` 命令統籌了建立您初始專案文件的整個流程。它結合了自動化程式碼分析與互動式審查流程，以產出一套結構化且相關的文件。
+
+文件產生後，您可能會想：
+
+-   [更新文件](./guides-updating-documentation.md)：對特定文件進行變更。
+-   [翻譯文件](./guides-translating-documentation.md)：將您的內容翻譯成其他語言。
+-   [發佈您的文件](./guides-publishing-your-docs.md)：將您的文件發佈到網路上。

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

@@ -0,0 +1,149 @@
+# 生成文档
+
+本指南提供了一个系统化的流程，用于从您项目的源文件创建一套完整的文档。该过程通过 `aigne doc generate` 命令启动，该命令会分析您的代码库，提出一个逻辑结构，然后为每个文档编写内容。
+
+该命令是初次创建文档的主要工具。如需在文档创建后进行修改，请参阅[更新文档](./guides-updating-documentation.md)指南。
+
+### 生成工作流
+
+`generate` 命令执行一系列自动化步骤来构建您的文档。该过程设计为交互式，允许您在内容写入前审查和批准建议的结构。
+
+```d2
+direction: down
+
+start: {
+  label: "开始"
+  shape: oval
+}
+
+run_command: {
+  label: "运行 'aigne doc generate'"
+  shape: rectangle
+}
+
+check_config: {
+  label: "配置文件是否存在？"
+  shape: diamond
+}
+
+interactive_setup: {
+  label: "引导进行交互式设置"
+  shape: rectangle
+  tooltip: "如果未找到 .aigne/doc-smith/config.yaml，将触发交互式设置。"
+}
+
+propose_structure: {
+  label: "分析项目并提出文档结构"
+  shape: rectangle
+}
+
+review_structure: {
+  label: "用户审查建议的结构"
+  shape: rectangle
+}
+
+user_approve: {
+  label: "批准结构？"
+  shape: diamond
+}
+
+provide_feedback: {
+  label: "提供反馈以优化结构"
+  shape: rectangle
+  tooltip: "用户可以请求更改，例如重命名、添加或删除部分。"
+}
+
+generate_content: {
+  label: "为所有文档生成内容"
+  shape: rectangle
+}
+
+end: {
+  label: "结束"
+  shape: oval
+}
+
+start -> run_command
+run_command -> check_config
+check_config -> interactive_setup: {
+  label: "否"
+}
+interactive_setup -> propose_structure
+check_config -> propose_structure: {
+  label: "是"
+}
+propose_structure -> review_structure
+review_structure -> user_approve
+user_approve -> provide_feedback: {
+  label: "否"
+}
+provide_feedback -> review_structure
+user_approve -> generate_content: {
+  label: "是"
+}
+generate_content -> end
+```
+
+## 分步流程
+
+要生成您的文档，请在终端中导航到项目的根目录，并按照以下步骤操作。
+
+### 1. 运行生成命令
+
+执行 `generate` 命令以开始该过程。该工具将首先分析您项目的文件和结构。
+
+```bash 基础生成命令
+aigne doc generate
+```
+
+为简洁起见，您也可以使用别名 `gen` 或 `g`。
+
+### 2. 审查文档结构
+
+分析完成后，该工具将呈现一个建议的文档结构。该结构是即将创建的文档的层级计划。
+
+系统将提示您审查此计划：
+
+```
+您想优化文档结构吗？
+您可以编辑标题、重组章节。
+❯ 看起来不错 - 继续使用当前结构
+  是的，优化结构
+```
+
+-   **看起来不错 - 继续使用当前结构**：选择此选项以批准建议的结构，并直接进入内容生成阶段。
+-   **是的，优化结构**：如果您希望修改计划，请选择此选项。您将能够以纯文本形式提供反馈，例如“将‘API’重命名为‘API 参考’”或“为‘部署’添加一个新章节”。AI 将根据您的反馈修订结构，您可以再次审查。此循环可以重复，直到结构满足您的要求。
+
+### 3. 内容生成
+
+一旦文档结构获得批准，DocSmith 将开始为计划中的每个文档生成详细内容。此过程自动运行，其持续时间取决于项目的规模和复杂性。
+
+完成后，生成的文件将保存到您在配置中指定的输出目录（例如 `./docs`）。
+
+## 命令参数
+
+`generate` 命令接受几个可选参数来控制其行为。
+
+| 参数 | 描述 | 示例 |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `--forceRegenerate` | 从头开始重建所有文档，忽略任何现有结构或内容。这对于从头开始很有用。 | `aigne doc generate --forceRegenerate` |
+| `--feedback` | 在结构生成阶段提供初始指令以指导 AI。 | `aigne doc generate --feedback "添加更多 API 示例和故障排除章节"` |
+| `--glossary` | 指定一个术语表文件（`.md`），以确保在整个文档中术语使用的一致性。 | `aigne doc generate --glossary @/path/to/glossary.md` |
+
+### 示例：强制完全重建
+
+如果您想丢弃所有先前生成的文档，并根据代码的当前状态创建一套新的文档，请使用 `--forceRegenerate` 标志。
+
+```bash 强制重新生成
+aigne doc generate --forceRegenerate
+```
+
+## 总结
+
+`generate` 命令协调了创建初始项目文档的整个过程。它将自动代码分析与交互式审查过程相结合，以生成一套结构化且相关的文档。
+
+文档生成后，您可能希望：
+
+-   [更新文档](./guides-updating-documentation.md)：对特定文档进行更改。
+-   [翻译文档](./guides-translating-documentation.md)：将您的内容翻译成其他语言。
+-   [发布您的文档](./guides-publishing-your-docs.md)：将您的文档在线发布。

package/docs/guides-interactive-chat.ja.md

@@ -0,0 +1,85 @@
+# 対話型チャット
+
+対話型チャットアシスタントは、ドキュメントの生成、修正、管理を行うための会話形式のインターフェースを提供します。個々のコマンドを実行する代わりに、何をしたいかを説明するだけで、アシスタントがプロセスを案内し、適切なツールを呼び出してタスクを完了します。
+
+このアプローチは、裏側で実行されるコマンドを自動的に処理することで、ドキュメント作成のワークフローを簡素化します。このツールを使用するほとんどのインタラクションにおいて、この方法が推奨されます。
+
+## チャットアシスタントの開始
+
+対話型セッションを開始するには、ターミナルから `chat` コマンドを実行します。
+
+```bash
+aigndoc chat
+```
+
+これによりアシスタントが起動し、リクエストの入力を開始できます。
+
+## 主な機能
+
+チャットアシスタントは、ドキュメント作成のライフサイクル全体を処理するように設計されています。その主な機能は以下の通りです。
+
+<x-cards data-columns="2">
+  <x-card data-title="ドキュメントの生成" data-icon="lucide:file-plus-2">
+    プロジェクトのソースファイルを分析して、完全なドキュメント構造と初期コンテンツを作成します。
+  </x-card>
+  <x-card data-title="改良と更新" data-icon="lucide:edit">
+    フィードバックやソースコードの変更に基づいて、特定のセクションまたはドキュメント全体を再生成します。
+  </x-card>
+  <x-card data-title="コンテンツの翻訳" data-icon="lucide:languages">
+    既存のドキュメントを多言語に翻訳し、より多くの読者に届けます。
+  </x-card>
+  <x-card data-title="公開と管理" data-icon="lucide:upload-cloud">
+    ドキュメントの公開とチームベースのワークフローの管理を支援します。
+  </x-card>
+</x-cards>
+
+## 利用可能なコマンド
+
+チャット内では、目標を平易な言葉で述べたり（例：「入門ガイドを更新して」）、特定のコマンドを呼び出したりすることができます。アシスタントは、その専門的なスキルに対応する以下のコアコマンドを理解します。
+
+| Command | Description |
+| :--- | :--- |
+| `generate` | ソースファイルから新しいドキュメント構造を作成するプロセスを開始します。 |
+| `update` | コードの変更やユーザーのフィードバックに基づいて、既存のドキュメントを修正します。 |
+| `translate` | ドキュメントを1つ以上の対応言語に翻訳します。 |
+| `publish` | ドキュメントを公開し、オンラインでアクセスできるようにします。 |
+| `init` | プロジェクトの初期設定ファイルの作成をガイドします。 |
+| `clear` | 生成されたファイル、設定、キャッシュデータを削除します。 |
+| `prefs` | ドキュメント生成のために保存された設定を管理します。 |
+| `evaluate` | 生成されたドキュメントの品質と完全性を評価します。 |
+| `history` | ドキュメントに加えられた更新の履歴を表示します。 |
+| `exit` | 対話型チャットセッションを終了します。 |
+
+## 対話例
+
+以下は、対話型アシスタントがどのように機能するかを示す会話のサンプルです。
+
+```text
+あなた:
+> こんにちは、新しいプロジェクトのドキュメントを作成したいです。
+
+AI アシスタント:
+もちろんです。まず、プロジェクトの構造を分析する必要があります。ソースコードディレクトリへのパスを教えていただけますか？
+
+あなた:
+> ./src
+
+AI アシスタント:
+ありがとうございます。./src 内のファイルを分析し、ドキュメント構造を提案します。これには少し時間がかかる場合があります...
+...
+プロジェクトの分析が完了し、提案する構造を作成しました。コンテンツの生成に進む前に、ご確認いただけますか？ (yes/no)
+
+あなた:
+> yes
+
+AI アシスタント:
+(レビュー用に提案されたドキュメント構造を表示)
+...
+上記の構造をご確認ください。どの部分でも追加、削除、修正を依頼できます。
+```
+
+## まとめ
+
+対話型チャットアシスタントは、ガイド付きの会話形式でドキュメントを管理するための強力なツールです。必要な手順やコマンドを自動で処理することで、複雑なタスクを効率化します。
+
+特定のワークフローに関するより詳細なウォークスルーについては、[ドキュメントの生成](./guides-generating-documentation.md) ガイドを参照してください。