@aigne/doc-smith 0.8.11-beta.6 → 0.8.11-beta.7

package/docs/features-update-and-refine.zh.md

@@ -1,138 +1,90 @@
-# 更新与完善
+# 更新和优化
 
-让文档与不断演进的代码库保持同步是一个系统性的过程。AIGNE DocSmith 提供了直接而灵活的命令来保持内容最新，既可以通过基于代码变更的自动更新，也可以通过精确的、由反馈驱动的完善。
+让文档与不断演进的代码库保持同步是一个系统性的过程。AIGNE DocSmith 提供了直接且灵活的命令，可以通过基于代码变更的自动更新或通过精确、由反馈驱动的优化来保持您的内容为最新状态。
 
-本指南涵盖了以下操作流程：
+本指南提供了执行以下任务的步骤：
 
-- 在源代码修改时自动更新文档。
-- 使用针对性的反馈重新生成特定文档。
-- 调整整体文档结构。
+*   在源代码修改时自动更新文档。
+*   使用有针对性的反馈重新生成特定文档。
+*   调整整体文档结构。
 
 ### 文档更新工作流
 
-下图展示了更新文档可用的不同工作流：
+下图说明了可用于更新文档的不同工作流：
 
 ```d2 文档更新工作流
 direction: down
 
-developer: {
+Developer: {
   shape: c4-person
-  label: "开发者"
 }
 
-codebase: {
-  shape: cylinder
+Source-Code: {
   label: "源代码"
 }
 
-updated-documentation: {
-  shape: cylinder
-  label: "更新后的\n文档"
+Documentation: {
+  label: "文档"
 }
 
-workflows: {
-  label: "文档更新工作流"
+Action-Choice: {
+  label: "选择操作"
+  shape: diamond
+}
+
+Generate-Sync: {
+  label: "aigne doc generate"
   shape: rectangle
 
-  automatic-updates: {
-    label: "自动更新（代码驱动）"
-    shape: rectangle
+  Change-Detection: {
+    label: "检测变更？"
+    shape: diamond
+  }
+  Regenerate-Affected: "重新生成受影响部分"
+  Regenerate-All: "重新生成全部"
 
-    cmd-generate: {
-      label: "aigne doc generate"
-    }
+  Change-Detection -> Regenerate-Affected: "是 (默认)"
+  Change-Detection -> Regenerate-All: "否\n(--forceRegenerate)"
+}
 
-    decision-force: {
-      label: "--forceRegenerate?"
-      shape: diamond
-    }
+Refine-Content: {
+  label: "aigne doc update"
+}
 
-    detect-changes: {
-      label: "检测变更"
-    }
+Refine-Structure: {
+  label: "aigne doc generate\n--feedback"
+}
 
-    regen-affected: {
-      label: "重新生成\n受影响的文档"
-    }
+Developer -> Action-Choice
 
-    regen-all: {
-      label: "重新生成\n所有文档"
-    }
-  }
+Action-Choice -> Generate-Sync: "与代码同步"
+Action-Choice -> Refine-Content: "优化文档内容"
+Action-Choice -> Refine-Structure: "优化文档结构"
 
-  manual-refinements: {
-    label: "手动完善（反馈驱动）"
-    shape: rectangle
-    grid-columns: 2
-    grid-gap: 100
-
-    refine-individual: {
-      label: "完善单个文档"
-      shape: rectangle
-
-      cmd-update: {
-        label: "aigne doc update\n--feedback"
-      }
-
-      regen-specific: {
-        label: "重新生成\n特定文档"
-      }
-    }
-
-    optimize-structure: {
-      label: "优化整体结构"
-      shape: rectangle
-
-      cmd-generate-feedback: {
-        label: "aigne doc generate\n--feedback"
-      }
-
-      re-evaluate-plan: {
-        label: "重新评估\n文档计划"
-      }
-    }
-  }
-}
+Source-Code -> Generate-Sync
 
-# --- 连接 ---
-
-# 路径 1：自动更新
-developer -> codebase: "1. 进行变更"
-codebase -> workflows.automatic-updates.cmd-generate: "2. 运行命令"
-workflows.automatic-updates.cmd-generate -> workflows.automatic-updates.decision-force
-workflows.automatic-updates.decision-force -> workflows.automatic-updates.detect-changes: "否"
-workflows.automatic-updates.detect-changes -> workflows.automatic-updates.regen-affected
-workflows.automatic-updates.decision-force -> workflows.automatic-updates.regen-all: "是"
-workflows.automatic-updates.regen-affected -> updated-documentation
-workflows.automatic-updates.regen-all -> updated-documentation
-
-# 路径 2：单个完善
-developer -> workflows.manual-refinements.refine-individual.cmd-update: "3. 提供\n内容反馈"
-workflows.manual-refinements.refine-individual.cmd-update -> workflows.manual-refinements.refine-individual.regen-specific
-workflows.manual-refinements.refine-individual.regen-specific -> updated-documentation
-
-# 路径 3：结构完善
-developer -> workflows.manual-refinements.optimize-structure.cmd-generate-feedback: "4. 提供\n结构反馈"
-workflows.manual-refinements.optimize-structure.cmd-generate-feedback -> workflows.manual-refinements.optimize-structure.re-evaluate-plan
-workflows.manual-refinements.optimize-structure.re-evaluate-plan -> updated-documentation: "使用\n新结构重新生成"
+Generate-Sync.Regenerate-Affected -> Documentation: "更新"
+Generate-Sync.Regenerate-All -> Documentation: "更新"
+Refine-Content -> Documentation: "更新"
+Refine-Structure -> Documentation: "更新"
 ```
 
 ---
 
-## 通过变更检测实现自动更新
+## 通过变更检测自动更新
 
-当您执行 `aigne doc generate` 命令时，DocSmith 会首先分析您的代码库以检测自上次生成以来的变更。然后，它仅重新生成受这些变更影响的文档。这种默认行为可以节省时间并减少 API 使用量。
+当您执行 `aigne doc generate` 命令时，DocSmith 会首先分析您的代码库，以检测自上次生成以来的变更。然后，它仅重新生成受这些变更影响的文档。这种默认行为通过避免冗余操作来节省时间并减少 API 使用。
 
 ```shell icon=lucide:terminal
-# DocSmith 将检测变更并仅更新必要的部分
+# DocSmith 将检测变更并仅更新必要部分
 aigne doc generate
 ```
 
-![DocSmith 检测变更并仅重新生成所需文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+![DocSmith 检测变更并仅重新生成所需文档。](../assets/screenshots/doc-regenerate.png)
 
 ### 强制完全重新生成
 
-要从头开始重新生成所有文档，绕过缓存和变更检测，请使用 `--forceRegenerate` 标志。当您进行了重大的配置更改或需要完全重建以确保一致性时，此操作是必需的。
+要从头开始重新生成所有文档，绕过缓存和变更检测，请使用 `--forceRegenerate` 标志。当您进行了重大的配置更改或需要完全重建以确保所有文件的一致性时，这是必要的。
 
 ```shell icon=lucide:terminal
 # 从头开始重新生成所有文档
@@ -141,52 +93,50 @@ aigne doc generate --forceRegenerate
 
 ---
 
-## 完善单个文档
+## 通过反馈优化文档
+
+您可以通过向 CLI 命令提供直接反馈来优化文档，而无需进行相应的代码更改。这对于提高清晰度、添加示例或调整结构非常有用。
 
-要在没有相应代码变更的情况下改进特定文档的内容，请使用 `aigne doc update` 命令。此命令允许您提供针对性的完善指令。
+### 优化单个文档内容
 
-这可以通过交互方式或通过命令行参数以非交互方式完成。
+要改进特定文档的内容，请使用 `aigne doc update` 命令。该命令允许您提供有针对性的优化指令，并可以在两种模式下运行：交互式或非交互式。
 
-### 交互模式
+#### 交互模式
 
-要进行引导式流程，请不带参数运行该命令。DocSmith 将会显示一个菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
+要进行引导式流程，请在不带参数的情况下运行该命令。DocSmith 将会显示一个菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
 
 ```shell icon=lucide:terminal
 # 启动交互式更新流程
 aigne doc update
 ```
 
-![以交互方式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+![以交互方式选择您希望更新的文档。](../assets/screenshots/doc-update.png)
 
-### 直接通过命令行更新
+#### 非交互模式
 
 对于脚本化或更快速的工作流，您可以使用标志直接指定文档和反馈。这样可以实现精确的非交互式更新。
 
 ```shell icon=lucide:terminal
 # 使用反馈更新特定文档
-aigne doc update --docs overview.md --feedback "在末尾添加更详细的常见问题解答部分。"
+aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
 ```
 
 `update` 命令的主要参数如下：
 
 | 参数 | 描述 |
-| --- | --- |
+| :--- | :--- |
 | `--docs` | 要更新的文档的路径。此标志可以多次使用以进行批量更新。 |
-| `--feedback` | 重新生成内容时要使用的具体指令。 |
-
----
-
-## 优化整体结构
+| `--feedback` | 一个包含在重新生成文档内容时要使用的具体指令的字符串。 |
 
-除了完善单个文档内容外，您还可以调整整体文档结构。如果现有组织结构不理想或缺少某个部分，您可以向 `generate` 命令提供反馈。
+### 优化整体结构
 
-这会指示 DocSmith 根据您的输入重新评估整个文档计划。
+除了优化单个文档外，您还可以调整整体文档结构。如果现有组织结构不理想或缺少某个部分，您可以向 `generate` 命令提供反馈。这会指示 DocSmith 根据您的输入重新评估整个文档计划。
 
 ```shell icon=lucide:terminal
 # 使用特定反馈重新生成文档结构
-aigne doc generate --feedback "删除‘关于’部分，并添加详细的‘API 参考’。"
+aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
 ```
 
-此方法适用于文档目录的高级别更改，而非次要内容编辑。
+此方法旨在对文档的目录进行高层级更改，而非对单个文件内的细微内容进行编辑。
 
-内容完善后，下一步是为全球受众做准备。有关说明，请参阅 [翻译文档](./features-translate-documentation.md) 指南。
+内容优化后，下一步是为全球受众做准备。有关说明，请参阅[翻译文档](./features-translate-documentation.md)指南。

package/docs/features.ja.md

@@ -1,52 +1,62 @@
 # コア機能
 
-AIGNE DocSmithは、ドキュメントのライフサイクルを管理するための一連のコマンドを提供します。初期作成からグローバルな配布までをサポートします。このプロセスは、ドキュメントの生成、改良、翻訳、公開という標準的なワークフローに整理されています。
+AIGNE DocSmithは、初期作成からグローバルな配布まで、ドキュメントのライフサイクルを管理するための一連のコマンドを提供します。プロセスは、ドキュメントの生成、改良、翻訳、公開という標準的なワークフローに整理されています。
 
 ```d2
 direction: down
 
-Generate: {
-  label: "1. 生成\naigne doc generate"
+source-code: {
+  label: "ソースコード"
   shape: rectangle
-  description: "ソースコードから完全なドキュメントセットを作成します。"
 }
 
-Refine: {
-  label: "2. 更新と改良\naigne doc update"
+generate-documentation: {
+  label: "ドキュメントの生成"
   shape: rectangle
-  description: "ドキュメントをコードと同期させ、的を絞ったフィードバックを適用します。"
 }
 
-Translate: {
-  label: "3. 翻訳\naigne doc translate"
+update-and-refine: {
+  label: "更新と改良"
   shape: rectangle
-  description: "グローバルな読者のために、コンテンツを複数の言語にローカライズします。"
 }
 
-Publish: {
-  label: "4. 公開\naigne doc publish"
+translate-documentation: {
+  label: "ドキュメントの翻訳"
   shape: rectangle
-  description: "ドキュメントをパブリックまたはプライベートなプラットフォームにデプロイします。"
 }
 
-Generate -> Refine -> Translate -> Publish
+publish-docs: {
+  label: "ドキュメントの公開"
+  shape: rectangle
+}
+
+platform: {
+  label: "DocSmith プラットフォーム\n(またはセルフホスト)"
+  shape: cylinder
+}
+
+source-code -> generate-documentation
+generate-documentation -> update-and-refine
+update-and-refine -> translate-documentation
+translate-documentation -> publish-docs
+publish-docs -> platform
 ```
 
-以下のセクションで、DocSmithの主な機能について説明します。
+以下のセクションで、DocSmithの主な機能をご覧ください。
 
 <x-cards data-columns="2">
   <x-card data-title="ドキュメントの生成" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
     単一のコマンドを使用して、ソースコードから完全なドキュメントセットを作成します。
   </x-card>
   <x-card data-title="更新と改良" data-icon="lucide:edit" data-href="/features/update-and-refine">
-    ドキュメントをコードの変更と同期させたり、的を絞ったフィードバックで特定のドキュメントを再生成したりします。
+    ドキュメントをコードの変更と同期させたり、特定のフィードバックを基に特定のドキュメントを再生成したりします。
   </x-card>
   <x-card data-title="ドキュメントの翻訳" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    コンテンツを複数のサポートされている言語に翻訳し、プロジェクトを世界中のユーザーに利用可能にします。
+    コンテンツを複数の対応言語に翻訳し、プロジェクトを世界中のオーディエンスにアクセス可能にします。
   </x-card>
   <x-card data-title="ドキュメントの公開" data-icon="lucide:send" data-href="/features/publish-your-docs">
-    生成されたドキュメントを公式のDocSmithプラットフォームまたは自己ホスト型のインスタンスに公開します。
+    生成したドキュメントを公式のDocSmithプラットフォームまたは独自のセルフホストインスタンスに公開します。
   </x-card>
 </x-cards>
 
-これらの機能は、ドキュメント作成のための構造化されたワークフローを提供します。利用可能なすべてのコマンドとそのオプションの詳細なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。
+これらの機能は、ドキュメントを作成および保守するための構造化されたワークフローを提供します。利用可能なすべてのコマンドとそのオプションの詳細なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。

package/docs/features.md

@@ -1,35 +1,45 @@
 # Core Features
 
-AIGNE DocSmith provides a set of commands to manage your documentation lifecycle, from initial creation to global distribution. The process is organized into a standard workflow: generating, refining, translating, and publishing your documentation.
+AIGNE DocSmith provides a set of commands to manage the documentation lifecycle, from initial creation to global distribution. The process is organized into a standard workflow: generating, refining,translating, and publishing your documentation.
 
 ```d2
 direction: down
 
-Generate: {
-  label: "1. Generate\naigne doc generate"
+source-code: {
+  label: "Source Code"
   shape: rectangle
-  description: "Create a full documentation set from your source code."
 }
 
-Refine: {
-  label: "2. Update & Refine\naigne doc update"
+generate-documentation: {
+  label: "Generate Documentation"
   shape: rectangle
-  description: "Keep docs in sync with code and apply targeted feedback."
 }
 
-Translate: {
-  label: "3. Translate\naigne doc translate"
+update-and-refine: {
+  label: "Update and Refine"
   shape: rectangle
-  description: "Localize content into multiple languages for a global audience."
 }
 
-Publish: {
-  label: "4. Publish\naigne doc publish"
+translate-documentation: {
+  label: "Translate Documentation"
   shape: rectangle
-  description: "Deploy your documentation to public or private platforms."
 }
 
-Generate -> Refine -> Translate -> Publish
+publish-docs: {
+  label: "Publish Your Docs"
+  shape: rectangle
+}
+
+platform: {
+  label: "DocSmith Platform\n(or self-hosted)"
+  shape: cylinder
+}
+
+source-code -> generate-documentation
+generate-documentation -> update-and-refine
+update-and-refine -> translate-documentation
+translate-documentation -> publish-docs
+publish-docs -> platform
 ```
 
 Explore the main capabilities of DocSmith in the following sections:
@@ -49,4 +59,4 @@ Explore the main capabilities of DocSmith in the following sections:
   </x-card>
 </x-cards>
 
-These features provide a structured workflow for documentation. For a detailed list of all available commands and their options, see the [CLI Command Reference](./cli-reference.md).
+These features provide a structured workflow for creating and maintaining documentation. For a detailed list of all available commands and their options, refer to the [CLI Command Reference](./cli-reference.md).

package/docs/features.zh-TW.md

@@ -1,35 +1,45 @@
 # 核心功能
 
-AIGNE DocSmith 提供了一組指令來管理您的文件生命週期，從初始建立到全球發布。整個過程被組織成一個標準化的工作流程：產生、優化、翻譯和發布您的文件。
+AIGNE DocSmith 提供了一組指令來管理文件的生命週期，從初始建立到全球分發。整個過程被組織成一個標準的工作流程：產生、優化、翻譯和發布您的文件。
 
 ```d2
 direction: down
 
-Generate: {
-  label: "1. 產生\naigne doc generate"
+source-code: {
+  label: "原始碼"
   shape: rectangle
-  description: "從您的原始碼建立一套完整的文件。"
 }
 
-Refine: {
-  label: "2. 更新與優化\naigne doc update"
+generate-documentation: {
+  label: "產生文件"
   shape: rectangle
-  description: "保持文件與程式碼同步，並應用針對性的回饋。"
 }
 
-Translate: {
-  label: "3. 翻譯\naigne doc translate"
+update-and-refine: {
+  label: "更新與優化"
   shape: rectangle
-  description: "將內容本地化為多種語言，以服務全球受眾。"
 }
 
-Publish: {
-  label: "4. 發布\naigne doc publish"
+translate-documentation: {
+  label: "翻譯文件"
   shape: rectangle
-  description: "將您的文件部署到公開或私有平台。"
 }
 
-Generate -> Refine -> Translate -> Publish
+publish-docs: {
+  label: "發布您的文件"
+  shape: rectangle
+}
+
+platform: {
+  label: "DocSmith 平台\n（或自行託管）"
+  shape: cylinder
+}
+
+source-code -> generate-documentation
+generate-documentation -> update-and-refine
+update-and-refine -> translate-documentation
+translate-documentation -> publish-docs
+publish-docs -> platform
 ```
 
 在以下章節中探索 DocSmith 的主要功能：
@@ -39,14 +49,14 @@ Generate -> Refine -> Translate -> Publish
     使用單一指令從您的原始碼建立一套完整的文件。
   </x-card>
   <x-card data-title="更新與優化" data-icon="lucide:edit" data-href="/features/update-and-refine">
-    讓您的文件與程式碼變更保持同步，或根據針對性的回饋重新產生特定文件。
+    讓您的文件與程式碼變更保持同步，或根據具體回饋重新產生特定文件。
   </x-card>
   <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    將您的內容翻譯成多種支援的語言，讓您的專案能接觸到全球受眾。
+    將您的內容翻譯成多種支援的語言，讓您的專案能夠觸及全球使用者。
   </x-card>
   <x-card data-title="發布您的文件" data-icon="lucide:send" data-href="/features/publish-your-docs">
-    將您產生的文件發布到官方 DocSmith 平台或您自己託管的實例。
+    將您產生的文件發布到官方 DocSmith 平台或您自行託管的實例。
   </x-card>
 </x-cards>
 
-這些功能為文件提供了一個結構化的工作流程。有關所有可用指令及其選項的詳細清單，請參閱 [CLI 指令參考](./cli-reference.md)。
+這些功能提供了一個結構化的工作流程，用於建立和維護文件。有關所有可用指令及其選項的詳細列表，請參閱 [CLI 指令參考](./cli-reference.md)。

package/docs/features.zh.md

@@ -1,52 +1,62 @@
 # 核心功能
 
-AIGNE DocSmith 提供了一组命令来管理您的文档生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流：生成、优化、翻译和发布您的文档。
+AIGNE DocSmith 提供了一套命令来管理文档的整个生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流程：生成、优化、翻译和发布您的文档。
 
 ```d2
 direction: down
 
-Generate: {
-  label: "1. 生成\naigne doc generate"
+source-code: {
+  label: "源代码"
   shape: rectangle
-  description: "从您的源代码创建一套完整的文档。"
 }
 
-Refine: {
-  label: "2. 更新与优化\naigne doc update"
+generate-documentation: {
+  label: "生成文档"
   shape: rectangle
-  description: "保持文档与代码同步，并应用有针对性的反馈。"
 }
 
-Translate: {
-  label: "3. 翻译\naigne doc translate"
+update-and-refine: {
+  label: "更新与优化"
   shape: rectangle
-  description: "将内容本地化为多种语言，以面向全球受众。"
 }
 
-Publish: {
-  label: "4. 发布\naigne doc publish"
+translate-documentation: {
+  label: "翻译文档"
   shape: rectangle
-  description: "将您的文档部署到公共或私有平台。"
 }
 
-Generate -> Refine -> Translate -> Publish
+publish-docs: {
+  label: "发布文档"
+  shape: rectangle
+}
+
+platform: {
+  label: "DocSmith 平台\n(或自托管)"
+  shape: cylinder
+}
+
+source-code -> generate-documentation
+generate-documentation -> update-and-refine
+update-and-refine -> translate-documentation
+translate-documentation -> publish-docs
+publish-docs -> platform
 ```
 
-在以下部分中探索 DocSmith 的主要功能：
+在以下部分中，探索 DocSmith 的主要功能：
 
 <x-cards data-columns="2">
   <x-card data-title="生成文档" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
-    使用单个命令从您的源代码创建一套完整的文档。
+    使用单个命令从您的源代码创建一整套文档。
   </x-card>
   <x-card data-title="更新与优化" data-icon="lucide:edit" data-href="/features/update-and-refine">
-    使您的文档与代码更改保持同步，或根据有针对性的反馈重新生成特定文档。
+    让您的文档与代码更改保持同步，或根据特定反馈重新生成特定文档。
   </x-card>
   <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    将您的内容翻译成多种支持的语言，使您的项目能够触达全球受众。
+    将您的内容翻译成多种支持的语言，使您的项目能够面向全球受众。
   </x-card>
-  <x-card data-title="发布您的文档" data-icon="lucide:send" data-href="/features/publish-your-docs">
-    将您生成的文档发布到官方 DocSmith 平台或您自己自托管的实例。
+  <x-card data-title="发布文档" data-icon="lucide:send" data-href="/features/publish-your-docs">
+    将您生成的文档发布到官方 DocSmith 平台或您自己的自托管实例。
   </x-card>
 </x-cards>
 
-这些功能为文档工作提供了一个结构化的工作流。有关所有可用命令及其选项的详细列表，请参阅 [CLI 命令参考](./cli-reference.md)。
+这些功能为创建和维护文档提供了一个结构化的工作流程。有关所有可用命令及其选项的详细列表，请参阅 [CLI 命令参考](./cli-reference.md)。