@aigne/doc-smith 0.8.10 → 0.8.11-beta.1

package/docs/changelog.zh.md

@@ -1,6 +1,6 @@
 # 更新日志
 
-项目每个版本的所有重要变更、功能和错误修复的详细日志。
+项目每个版本的所有显著变更、功能和错误修复的详细日志。
 
 ## [0.8.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.1...v0.8.2) (2025-09-04)
 
@@ -26,7 +26,7 @@
 
 ### 功能
 
-* **测试：**添加全面的工作流测试覆盖率 ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
+* **测试：** 添加全面的工作流测试覆盖 ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
 * 更新自定义组件指南，增加格式限制 ([#79](https://github.com/AIGNE-io/aigne-doc-smith/issues/79)) ([76158de](https://github.com/AIGNE-io/aigne-doc-smith/commit/76158de236696e68c63c057f5ea4b8458a15e787))
 
 ## [0.7.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.1...v0.7.2) (2025-09-01)
@@ -41,14 +41,14 @@
 
 ### 错误修复
 
-* 修复 Tab 键路径选择错误 ([#72](https://github.com/AIGNE-io/aigne-doc-smith/issues/72)) ([369b342](https://github.com/AIGNE-io/aigne-doc-smith/commit/369b342d8ab8ce95b61a3b72e367157d2f71cce4))
+* 修复 tab 键路径选择错误 ([#72](https://github.com/AIGNE-io/aigne-doc-smith/issues/72)) ([369b342](https://github.com/AIGNE-io/aigne-doc-smith/commit/369b342d8ab8ce95b61a3b72e367157d2f71cce4))
 
 ## [0.7.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.6.0...v0.7.0) (2025-08-30)
 
 
 ### 功能
 
-* 增加聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
+* 添加聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
 * 支持自定义组件和更强大的配置处理 ([#70](https://github.com/AIGNE-io/aigne-doc-smith/issues/70)) ([727ab42](https://github.com/AIGNE-io/aigne-doc-smith/commit/727ab429b00f924ef605530b35d2a12b4be77e3a))
 * 在文档生成和发布工作流中支持 d2 图表 ([#69](https://github.com/AIGNE-io/aigne-doc-smith/issues/69)) ([bf95889](https://github.com/AIGNE-io/aigne-doc-smith/commit/bf958891516973636c4847b084c6fe75d1ea124b))
 * 支持多用途文档规划和生成 ([#68](https://github.com/AIGNE-io/aigne-doc-smith/issues/68)) ([44152c5](https://github.com/AIGNE-io/aigne-doc-smith/commit/44152c53b7e8f82e3af1245a1affd77b9817486d))
@@ -58,7 +58,7 @@
 
 ### 功能
 
-* 完成发布前媒体处理的全面支持 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
+* 完成发布前媒体处理的支持 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
 
 ## [0.5.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.5.0...v0.5.1) (2025-08-26)
 
@@ -133,7 +133,7 @@
 
 ### 功能
 
-* **核心：**优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
+* **核心：** 优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
 
 
 ### 错误修复
@@ -152,7 +152,7 @@
 
 ### 错误修复
 
-* 修复 bug bush 反馈 ([#41](https://github.com/AIGNE-io/aigne-doc-smith/issues/41)) ([2740d1a](https://github.com/AIGNE-io/aigne-doc-smith/commit/2740d1abef70ea36780b030917a6d54f74df4327))
+* 修复缺陷反馈 ([#41](https://github.com/AIGNE-io/aigne-doc-smith/issues/41)) ([2740d1a](https://github.com/AIGNE-io/aigne-doc-smith/commit/2740d1abef70ea36780b030917a6d54f74df4327))
 
 ## [0.2.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.8...v0.2.9) (2025-08-13)
 
@@ -192,14 +192,14 @@
 
 ### 错误修复
 
-* 优化 CLI 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
+* 优化 cli 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
 
 ## [0.2.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.3...v0.2.4) (2025-08-07)
 
 
 ### 错误修复
 
-* 优化 Agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
+* 优化 agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
 
 ## [0.2.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.2...v0.2.3) (2025-08-07)
 
@@ -227,7 +227,7 @@
 
 ### 功能
 
-* 支持调用 Agent 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
+* 支持调用 agents 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
 * 源文件变更时更新文档 ([#9](https://github.com/AIGNE-io/aigne-doc-smith/issues/9)) ([4adcecf](https://github.com/AIGNE-io/aigne-doc-smith/commit/4adcecfb32e72c9e88d0b0bd8ce0a91022847ca7))
 
 ## [0.1.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.3...v0.1.4) (2025-08-04)
@@ -242,7 +242,7 @@
 
 ### 错误修复
 
-* 从 options.context 访问 Agent，而不是加载新的 AIGNE 实例 ([#6](https://github.com/AIGNE-io/aigne-doc-smith/issues/6)) ([0e7ce1d](https://github.com/AIGNE-io/aigne-doc-smith/commit/0e7ce1d3889aab435b029a511cb7ebdbb213ab8a))
+* 从 options.context 访问 agents，而不是加载新的 aigne 实例 ([#6](https://github.com/AIGNE-io/aigne-doc-smith/issues/6)) ([0e7ce1d](https://github.com/AIGNE-io/aigne-doc-smith/commit/0e7ce1d3889aab435b029a511cb7ebdbb213ab8a))
 
 ## [0.1.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.1...v0.1.2) (2025-08-01)
 
@@ -256,7 +256,7 @@
 
 ### 错误修复
 
-* Agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
+* agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
 * docs mcp 添加文档搜索 ([de96e0e](https://github.com/AIGNE-io/aigne-doc-smith/commit/de96e0e08455831dc6918d5fbc59d38b6a921373))
 * 优化代码 ([8cb0a5c](https://github.com/AIGNE-io/aigne-doc-smith/commit/8cb0a5ce67cf009c672b2fb1aa9b89ef6d965a86))
 
@@ -265,33 +265,33 @@
 
 ### 功能
 
-* 为 mcp 服务器和 CLI 添加入口 Agent ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
+* 为 mcp 服务器和 cli 添加入口 agents ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
 
 
 ### 错误修复
 
 * 优化命令参数 ([#3](https://github.com/AIGNE-io/aigne-doc-smith/issues/3)) ([003f6b8](https://github.com/AIGNE-io/aigne-doc-smith/commit/003f6b8ae2c9e1af55ba1841458fa8567a0eb2f0))
-* 优化 docs mcp Agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
+* 优化 docs mcp agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
 
 ## 0.0.2 (2025-07-30)
 
 
 ### 功能
 
-* 添加自动创建看板 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
+* 添加自动创建看板功能 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
 * 添加 docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
-* 添加输入生成器 Agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
+* 添加输入生成器 agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
 * 添加发布文档功能 ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
 * 添加对文档标签的支持 ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
-* 详情添加审查 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
+* 详情添加审查功能 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
 * 初始提交 ([dafc40e](https://github.com/AIGNE-io/aigne-doc-smith/commit/dafc40e94f3c407e50b2c46ecb46237f23a15cf7))
-* 结构规划添加审查 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
+* 结构计划添加审查功能 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
 
 
 ### 错误修复
 
-* 优化 Agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
-* 优化 Agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
+* 优化 agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
+* 优化 agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
 * 优化代码 ([34f9a24](https://github.com/AIGNE-io/aigne-doc-smith/commit/34f9a24fc3748b4177cad2b5330fe6b3ccd99175))
 * 优化代码 ([0343486](https://github.com/AIGNE-io/aigne-doc-smith/commit/0343486aa086bbe2ced8de849de6a4a42567719c))
 * 优化代码 ([7b7dfb9](https://github.com/AIGNE-io/aigne-doc-smith/commit/7b7dfb925b3aa55956ef7a99ededc749fb6a42d7))
@@ -299,11 +299,11 @@
 * 优化代码 ([74fee51](https://github.com/AIGNE-io/aigne-doc-smith/commit/74fee51ad6337af8811a35f2a4334b67ec109439))
 * 优化代码 ([7fa1675](https://github.com/AIGNE-io/aigne-doc-smith/commit/7fa1675b2cab6144d1fb9d4388130209c6cfa0bc))
 * 优化文档审查 ([70374ab](https://github.com/AIGNE-io/aigne-doc-smith/commit/70374abed74946eafa7b0f87331c2e496fa61592))
-* 优化输入生成器 Agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
-* 优化结构规划 ([3a0a196](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a0a196a97196ba445c4709d3466ff355917ac53))
+* 优化输入生成器 agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
+* 优化结构计划 ([3a0a196](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a0a196a97196ba445c4709d3466ff355917ac53))
 * 保存文档时移除无用文档 ([bec5ba3](https://github.com/AIGNE-io/aigne-doc-smith/commit/bec5ba3afd462c990a0aa813bbe38ce9a61363ee))
 
 
 ### 其他杂项
 
-* 发布 0.0.2 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))
+* 发布 0.0.2 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))

package/docs/cli-reference.ja.md

@@ -0,0 +1,210 @@
+# CLIコマンドリファレンス
+
+このガイドでは、利用可能なすべての `aigne doc` サブコマンド、その引数、およびオプションのリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
+
+一般的な構文は次のとおりです。
+
+```bash
+aigne doc <command> [options]
+```
+
+### コマンドのワークフロー
+
+以下の図は、DocSmithのCLIコマンドを使用してドキュメントを作成および保守する典型的なライフサイクルを示しています。
+
+```d2
+direction: down
+
+Start: {
+  label: "プロジェクトのセットアップ"
+  shape: circle
+}
+
+init: {
+  label: "aigne doc init\n(対話式セットアップ)"
+  shape: rectangle
+}
+
+generate: {
+  label: "aigne doc generate\n(全ドキュメントの作成/更新)"
+  shape: rectangle
+}
+
+refinement-cycle: {
+  label: "改良サイクル"
+  shape: rectangle
+  grid-columns: 2
+
+  update: {
+    label: "aigne doc update\n(単一ドキュメントの改良)"
+  }
+  translate: {
+    label: "aigne doc translate\n(コンテンツのローカライズ)"
+  }
+}
+
+publish: {
+  label: "aigne doc publish\n(ドキュメントのデプロイ)"
+  shape: rectangle
+}
+
+End: {
+  label: "ドキュメント公開"
+  shape: circle
+  style.fill: "#a2eeaf"
+}
+
+Start -> init: "任意" {
+  style.stroke-dash: 4
+}
+init -> generate: "設定"
+Start -> generate: "直接"
+generate -> refinement-cycle: "改良"
+refinement-cycle -> publish: "準備完了"
+generate -> publish: "直接デプロイ"
+publish -> End
+```
+
+---
+
+## `aigne doc generate`
+
+ソースコードを分析し、設定に基づいてドキュメント一式を生成します。設定が見つからない場合は、対話式のセットアップウィザードが自動的に起動します。
+
+### オプション
+
+| オプション          | タイプ  | 説明                                                                                          |
+| ------------------- | ------- | --------------------------------------------------------------------------------------------- |
+| `--feedback`        | string  | ドキュメント全体の構造を調整および改良するためのフィードバックを提供します。                    |
+| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。                        |
+| `--model`           | string  | 生成に使用する特定の言語モデルを指定します（例：`openai:gpt-4o`）。デフォルトを上書きします。 |
+
+### 使用例
+
+**ドキュメントを生成または更新する：**
+
+```bash
+aigne doc generate
+```
+
+**すべてのドキュメントを強制的に再生成する：**
+
+```bash
+aigne doc generate --forceRegenerate
+```
+
+**フィードバックをもとにドキュメント構造を改良する：**
+
+```bash
+aigne doc generate --feedback "APIの例のセクションを新しく追加し、「概要」ページを削除してください。"
+```
+
+**AIGNE Hubの特定のモデルを使用して生成する：**
+
+```bash
+aigne doc generate --model google:gemini-1.5-flash
+```
+
+---
+
+## `aigne doc update`
+
+特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定することができます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて対象を絞った改善を行うのに役立ちます。
+
+### オプション
+
+| オプション   | タイプ  | 説明                                                                                |
+| ---------- | ----- | ----------------------------------------------------------------------------------- |
+| `--docs`     | array | 再生成するドキュメントのパスのリスト。複数回使用できます。                          |
+| `--feedback` | string | 選択したドキュメントのコンテンツを改善するための具体的なフィードバックを提供します。|
+
+### 使用例
+
+**更新するドキュメントを選択するための対話セッションを開始する：**
+
+```bash
+aigne doc update
+```
+
+**特定のドキュメントを対象を絞ったフィードバックで更新する：**
+
+```bash
+aigne doc update --docs overview.md --feedback "より詳細なFAQ項目を追加してください"
+```
+
+---
+
+## `aigne doc translate`
+
+既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントと言語を選択するか、引数として指定して非対話形式で実行することができます。
+
+### オプション
+
+| オプション     | タイプ  | 説明                                                                                             |
+| ------------ | ----- | ------------------------------------------------------------------------------------------------ |
+| `--docs`       | array | 翻訳するドキュメントのパスのリスト。複数回使用できます。                                         |
+| `--langs`      | array | ターゲット言語コードのリスト（例：`zh`、`ja`）。複数回使用できます。                               |
+| `--feedback`   | string | 翻訳の品質を向上させるためのフィードバックを提供します。                                           |
+| `--glossary`   | string | 言語間で一貫した用語を確保するための用語集ファイルへのパス。`@path/to/glossary.md` を使用します。 |
+
+### 使用例
+
+**対話型の翻訳セッションを開始する：**
+
+```bash
+aigne doc translate
+```
+
+**特定のドキュメントを中国語と日本語に翻訳する：**
+
+```bash
+aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
+```
+
+**用語集とフィードバックを使用して、より高品質な翻訳を行う：**
+
+```bash
+aigne doc translate --glossary @glossary.md --feedback "専門用語を一貫して使用してください"
+```
+
+---
+
+## `aigne doc publish`
+
+生成されたドキュメントをDiscuss Kitプラットフォームに公開します。公式のAIGNE DocSmithプラットフォーム、または自己ホスト型のインスタンスに公開できます。
+
+### オプション
+
+| オプション   | タイプ  | 説明                                                                                         |
+| ---------- | ------ | -------------------------------------------------------------------------------------------- |
+| `--appUrl` | string | 自己ホスト型のDiscuss KitインスタンスのURL。指定しない場合、コマンドは対話形式で実行されます。 |
+
+### 使用例
+
+**対話型の公開セッションを開始する：**
+
+```bash
+aigne doc publish
+```
+
+**自己ホスト型のインスタンスに直接公開する：**
+
+```bash
+aigne doc publish --appUrl https://your-discuss-kit-instance.com
+```
+
+---
+
+## `aigne doc init`
+
+対話式の構成ウィザードを手動で開始します。これは、新しいプロジェクトを設定したり、既存のプロジェクトの構成を変更したりするのに役立ちます。ウィザードは、ソースコードのパスの定義、出力ディレクトリの設定、言語の選択、ドキュメントのスタイルと対象読者の定義を案内します。
+
+### 使用例
+
+**セットアップウィザードを起動する：**
+
+```bash
+aigne doc init
+```
+
+DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。

package/docs/cli-reference.zh-TW.md

@@ -0,0 +1,210 @@
+# CLI 命令參考
+
+本指南為所有可用的 `aigne doc` 子命令、其參數和選項提供參考。它旨在幫助使用者充分利用命令列介面。
+
+一般語法為：
+
+```bash
+aigne doc <command> [options]
+```
+
+### 命令工作流程
+
+下圖說明了使用 DocSmith 的 CLI 命令建立和維護文件的典型生命週期：
+
+```d2
+direction: down
+
+Start: {
+  label: "專案設定"
+  shape: circle
+}
+
+init: {
+  label: "aigne doc init\n(互動式設定)"
+  shape: rectangle
+}
+
+generate: {
+  label: "aigne doc generate\n(建立/更新所有文件)"
+  shape: rectangle
+}
+
+refinement-cycle: {
+  label: "優化週期"
+  shape: rectangle
+  grid-columns: 2
+
+  update: {
+    label: "aigne doc update\n(優化單一文件)"
+  }
+  translate: {
+    label: "aigne doc translate\n(內容本地化)"
+  }
+}
+
+publish: {
+  label: "aigne doc publish\n(部署文件)"
+  shape: rectangle
+}
+
+End: {
+  label: "文件上線"
+  shape: circle
+  style.fill: "#a2eeaf"
+}
+
+Start -> init: "可選" {
+  style.stroke-dash: 4
+}
+init -> generate: "配置"
+Start -> generate: "直接"
+generate -> refinement-cycle: "優化"
+refinement-cycle -> publish: "就緒"
+generate -> publish: "直接部署"
+publish -> End
+```
+
+---
+
+## `aigne doc generate`
+
+分析您的原始碼並根據您的設定產生一套完整的文件。如果找不到設定，它會自動啟動互動式設定精靈。
+
+### 選項
+
+| Option              | Type    | Description                                                                                                   |
+| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
+| `--feedback`        | string  | 提供回饋以調整和優化整體文件結構。                                                                            |
+| `--forceRegenerate` | boolean | 捨棄現有內容並從頭開始重新產生所有文件。                                                                        |
+| `--model`           | string  | 指定用於產生的特定大型語言模型（例如 `openai:gpt-4o`）。此選項會覆蓋預設設定。                                    |
+
+### 使用範例
+
+**產生或更新文件：**
+
+```bash
+aigne doc generate
+```
+
+**強制完整重新產生所有文件：**
+
+```bash
+aigne doc generate --forceRegenerate
+```
+
+**透過回饋優化文件結構：**
+
+```bash
+aigne doc generate --feedback "Add a new section for API examples and remove the 'About' page."
+```
+
+**使用 AIGNE Hub 中的特定模型產生：**
+
+```bash
+aigne doc generate --model google:gemini-1.5-flash
+```
+
+---
+
+## `aigne doc update`
+
+優化並重新產生特定文件。您可以以互動方式執行以選擇文件，或使用選項直接指定。這對於根據回饋進行有針對性的改進，而無需重新產生整個專案非常有用。
+
+### 選項
+
+| Option     | Type  | Description                                                                                 |
+| ---------- | ----- | ------------------------------------------------------------------------------------------- |
+| `--docs`     | array | 要重新產生的文件路徑列表。可多次使用。                                                        |
+| `--feedback` | string | 提供具體回饋以改善所選文件的內容。                                                            |
+
+### 使用範例
+
+**啟動互動式會話以選擇要更新的文件：**
+
+```bash
+aigne doc update
+```
+
+**使用針對性回饋更新特定文件：**
+
+```bash
+aigne doc update --docs overview.md --feedback "Add more detailed FAQ entries"
+```
+
+---
+
+## `aigne doc translate`
+
+將現有文件翻譯成一種或多種語言。可以互動方式執行以選擇文件和語言，或透過將它們指定為參數以非互動方式執行。
+
+### 選項
+
+| Option       | Type  | Description                                                                                                |
+| ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
+| `--docs`       | array | 要翻譯的文件路徑列表。可多次使用。                                                                           |
+| `--langs`      | array | 目標語言代碼列表（例如 `zh`、`ja`）。可多次使用。                                                               |
+| `--feedback`   | string | 提供回饋以改善翻譯品質。                                                                                   |
+| `--glossary`   | string | 詞彙表檔案的路徑，以確保跨語言的術語一致性。使用 `@path/to/glossary.md`。                                  |
+
+### 使用範例
+
+**啟動互動式翻譯會話：**
+
+```bash
+aigne doc translate
+```
+
+**將特定文件翻譯成中文和日文：**
+
+```bash
+aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
+```
+
+**使用詞彙表和回饋進行翻譯以獲得更高品質：**
+
+```bash
+aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently"
+```
+
+---
+
+## `aigne doc publish`
+
+將您產生的文件發佈到 Discuss Kit 平台。您可以發佈到官方的 AIGNE DocSmith 平台或您自己託管的實例。
+
+### 選項
+
+| Option     | Type   | Description                                                                                          |
+| ---------- | ------ | ---------------------------------------------------------------------------------------------------- |
+| `--appUrl` | string | 您自行託管的 Discuss Kit 實例的 URL。如果未提供，此命令將以互動方式執行。                                |
+
+### 使用範例
+
+**啟動互動式發佈會話：**
+
+```bash
+aigne doc publish
+```
+
+**直接發佈到自行託管的實例：**
+
+```bash
+aigne doc publish --appUrl https://your-discuss-kit-instance.com
+```
+
+---
+
+## `aigne doc init`
+
+手動啟動互動式設定精靈。這對於設定新專案或修改現有專案的設定很有用。此精靈會引導您定義原始碼路徑、設定輸出目錄、選擇語言以及定義文件的風格和目標受眾。
+
+### 使用範例
+
+**啟動設定精靈：**
+
+```bash
+aigne doc init
+```
+
+有關如何根據您的需求量身訂做 DocSmith 的更多詳細資訊，請參閱 [設定指南](./configuration.md)。