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

package/docs/configuration-preferences.zh.md

@@ -1,21 +1,21 @@
 # 管理偏好
 
-AIGNE DocSmith 旨在从您的反馈中学习。当您优化或更正生成的内容时，DocSmith 可以将这些反馈转化为持久性规则，即偏好。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致应用。所有偏好都存储在项目根目录下 `.aigne/doc-smith/preferences.yml` 文件中，该文件为人类可读的 YAML 格式。
+AIGNE DocSmith 旨在通过你的反馈进行学习。当你优化或更正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好。这些规则确保你特定的风格、结构要求和内容策略在未来的文档任务中得到一致应用。所有偏好都存储在项目根目录下一个名为 `.aigne/doc-smith/preferences.yml` 的人类可读 YAML 文件中。
 
 ## 偏好生命周期
 
-下图说明了您的反馈如何成为一个可重用的规则，该规则可应用于未来的任务，并通过命令行进行管理。
+下图说明了你的反馈如何成为一个可重用的规则，该规则可应用于未来的任务，并可通过命令行进行管理。
 
 ```d2 偏好生命周期
 direction: down
 
 feedback: {
-  label: "1. 用户在 'refine' 或 'translate' 期间\n提供反馈"
+  label: "1. 用户在“优化”或“翻译”期间提供反馈"
   shape: rectangle
 }
 
 refiner: {
-  label: "2. Feedback Refiner Agent\n分析反馈"
+  label: "2. 反馈优化 Agent\n分析反馈"
   shape: rectangle
 }
 
@@ -30,7 +30,7 @@ pref_file: {
 }
 
 future_tasks: {
-  label: "4. 未来的任务\n应用已保存的规则"
+  label: "4. 未来任务\n应用已保存的规则"
   shape: rectangle
 }
 
@@ -48,87 +48,82 @@ cli <-> pref_file: "管理"
 
 ```
 
-### DocSmith 如何从反馈中学习
+### 如何创建偏好
 
-当您在 `refine` 或 `translate` 阶段提供反馈时，一个名为 'Feedback Refiner' 的内部 Agent 会分析您的输入。其目标是区分一次性修复（例如，更正拼写错误）和可重用策略（例如，“始终用英语编写代码注释”）。如果它确定反馈代表一个持久性指令，就会创建一个新的偏好规则。
+当你在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析你的输入。它会判断该反馈是一次性修复（例如，更正一个拼写错误）还是一个可重用的策略（例如，“始终用英语编写代码注释”）。如果它代表一个持久性指令，它就会创建一个新的偏好规则。
 
-每个规则都有几个关键属性来定义其行为：
+### 规则属性
 
-| 属性 | 描述 |
-|---|---|
-| **id** | 规则的唯一标识符（例如，`pref_a1b2c3d4`）。 |
-| **active** | 一个布尔值（`true`/`false`），指示规则当前是否已启用。 |
-| **scope** | 定义规则的应用时机：`global`、`structure`、`document` 或 `translation`。 |
-| **rule** | 将在未来任务中传递给 AI 的指令。 |
-| **feedback** | 您提供的原始自然语言反馈。 |
-| **createdAt** | 规则创建时的 ISO 8601 时间戳。 |
-| **paths** | 一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定路径生成的内容。 |
+保存在 `preferences.yml` 中的每个规则都具有以下结构：
 
-## 通过 CLI 管理偏好
+<x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
+<x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。未启用的规则在生成任务期间将被忽略。"></x-field>
+<x-field data-name="scope" data-type="string" data-desc="定义规则何时应用。有效范围为 'global'、'structure'、'document' 或 'translation'。"></x-field>
+<x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、提炼后的指令。"></x-field>
+<x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈，保留以供参考。"></x-field>
+<x-field data-name="createdAt" data-type="string" data-desc="表示规则创建时间的 ISO 8601 时间戳。"></x-field>
+<x-field data-name="paths" data-type="string[]" data-required="false" data-desc="一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定源文件生成的内容。"></x-field>
 
-您可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好。这允许您列出、激活、停用或永久删除规则。
+## 使用 CLI 管理偏好
+
+你可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好。这允许你列出、激活、停用或永久删除规则。
 
 ### 列出所有偏好
 
-要查看所有已保存的偏好（包括活动和非活动的），请使用 `--list` 标志。
+要查看所有已保存的偏好，包括已激活和未激活的，请使用 `--list` 标志。
 
 ```bash 列出所有偏好 icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-该命令会显示一个格式化列表，解释每个规则的状态、范围、ID 以及任何路径限制。
-
-**示例输出：**
+该命令会显示一个格式化列表，展示每个规则的状态、范围、ID 以及任何路径限制。
 
-```text 示例输出 icon=lucide:clipboard-list
+```text 输出示例 icon=lucide:clipboard-list
 # 用户偏好
 
 **格式说明：**
-- 🟢 = 活动偏好, ⚪ = 非活动偏好
+- 🟢 = 已激活的偏好, ⚪ = 未激活的偏好
 - [scope] = 偏好范围 (global, structure, document, translation)
-- ID = 偏好唯一标识符
+- ID = 唯一偏好标识符
 - Paths = 特定文件路径 (如果适用)
 
 🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   在概览文档末尾添加一个 'Next Steps' 部分。
+   在概览文档末尾添加“后续步骤”部分。
  
 ⚪ [document] pref_i9j0k1l2m3n4o5p6
    代码注释必须用英语编写。
- 
 ```
 
-### 切换偏好状态
-
-如果您想临时禁用某个规则而不删除它，可以切换其活动状态。请使用 `--toggle` 标志。
+### 停用和重新激活偏好
 
-不带 ID 运行该命令将启动交互模式，允许您选择一个或多个要切换的偏好：
+如果你想临时禁用一个规则而不删除它，可以使用 `--toggle` 标志来切换其激活状态。不带 ID 运行该命令将启动一个交互模式，允许你选择一个或多个偏好进行切换。
 
 ```bash 以交互方式切换偏好 icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-要直接切换特定规则，请使用 `--id` 标志提供其 ID：
+要直接切换特定规则，请使用 `--id` 标志提供其 ID。这对应于 `deactivateRule` 函数，该函数将规则的 `active` 属性设置为 `false`。
 
 ```bash 切换特定偏好 icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 ```
 
-### 移除偏好
+### 删除偏好
 
-要永久删除一个或多个偏好，请使用 `--remove` 标志。此操作无法撤销。
+要永久删除一个或多个偏好，请使用 `--remove` 标志。此操作对应于 `removeRule` 函数，且无法撤销。
 
-要进入交互式选择提示，请不带 ID 运行该命令：
+要进入交互式选择提示，请不带 ID 运行该命令。
 
-```bash 以交互方式移除偏好 icon=lucide:terminal
+```bash 以交互方式删除偏好 icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-要通过 ID 直接移除特定规则，请使用 `--id` 标志：
+要通过 ID 直接删除特定规则，请使用 `--id` 标志。
 
-```bash 移除特定偏好 icon=lucide:terminal
+```bash 删除特定偏好 icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 ```
 
 ## 后续步骤
 
-管理偏好是根据项目特定需求定制 DocSmith 的关键部分。要了解更多自定义选项，请查阅主要的[配置指南](./configuration.md)。
+管理偏好是根据项目特定需求定制 DocSmith 的关键部分。有关更多自定义选项，请查阅主要的[配置指南](./configuration.md)。

package/docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration Guide
 
-AIGNE DocSmith's behavior is controlled by a central file, `config.yaml`, typically located at `.aigne/doc-smith/config.yaml`. This file dictates the style, target audience, languages, and structure of your documentation.
+AIGNE DocSmith's behavior is controlled by a central file, `config.yaml`, located at `.aigne/doc-smith/config.yaml`. This file dictates the style, target audience, languages, and structure of your documentation.
 
 You can create and manage this file using the interactive setup wizard by running `aigne doc init`. For a step-by-step walkthrough, see the [Interactive Setup](./configuration-interactive-setup.md) guide.
 
@@ -10,7 +10,7 @@ Your documentation is shaped by several key areas of configuration. Explore thes
 
 <x-cards data-columns="2">
   <x-card data-title="Interactive Setup" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
-    Learn about the guided wizard that helps you configure your documentation project from scratch, including setting recommendations.
+    Learn about the guided wizard that helps you configure your documentation project, including setting recommendations and conflict detection.
   </x-card>
   <x-card data-title="LLM Setup" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
     Discover how to connect different AI models, including using the built-in AIGNE Hub which requires no API keys.
@@ -33,8 +33,8 @@ These settings provide basic context about your project, which is used when publ
 
 | Parameter | Description |
 |---|---|
-| `projectName` | The name of your project. Automatically detected from `package.json` if available. |
-| `projectDesc` | A short description of your project. Automatically detected from `package.json`. |
+| `projectName` | The name of your project. Detected from `package.json` if available. |
+| `projectDesc` | A short description of your project. Detected from `package.json`. |
 | `projectLogo` | A path or URL to your project's logo image. |
 
 ### Documentation Strategy
@@ -42,7 +42,7 @@ These settings provide basic context about your project, which is used when publ
 These parameters define the tone, style, and depth of the generated content.
 
 #### `documentPurpose`
-What is the main outcome you want readers to achieve? This setting influences the overall structure and focus of the documentation.
+Defines the main outcome you want readers to achieve. This setting influences the overall structure and focus of the documentation.
 
 | Option | Name | Description |
 |---|---|---|
@@ -54,7 +54,7 @@ What is the main outcome you want readers to achieve? This setting influences th
 | `mixedPurpose` | Serve multiple purposes | Documentation covering multiple needs. |
 
 #### `targetAudienceTypes`
-Who will be reading this documentation most often? This choice affects the writing style and examples.
+Defines who will be reading this documentation most often. This choice affects the writing style and examples.
 
 | Option | Name | Description |
 |---|---|---|
@@ -66,7 +66,7 @@ Who will be reading this documentation most often? This choice affects the writi
 | `mixedTechnical`| Mixed technical audience | Developers, DevOps, and other technical users. |
 
 #### `readerKnowledgeLevel`
-What do readers typically know when they arrive? This adjusts how much foundational knowledge is assumed.
+Defines what readers typically know when they arrive. This adjusts how much foundational knowledge is assumed.
 
 | Option | Name | Description |
 |---|---|---|
@@ -77,7 +77,7 @@ What do readers typically know when they arrive? This adjusts how much foundatio
 | `exploringEvaluating` | Is evaluating this tool against others | Trying to understand if this fits their needs. |
 
 #### `documentationDepth`
-How comprehensive should the documentation be?
+Defines how comprehensive the documentation should be.
 
 | Option | Name | Description |
 |---|---|---|
@@ -92,8 +92,8 @@ For more granular control, you can provide free-text instructions.
 
 | Parameter | Description |
 |---|---|
-| `rules` | A multi-line string where you can define specific documentation generation rules and requirements (e.g., "Always include performance benchmarks"). |
-| `targetAudience`| A multi-line string to describe your specific target audience and their characteristics in more detail than the presets allow. |
+| `rules` | A multi-line string where you can define specific documentation generation rules (e.g., "Always include performance benchmarks"). |
+| `targetAudience`| A multi-line string to describe your specific target audience in more detail than the presets allow. |
 
 ### Language and Path Configuration
 
@@ -109,56 +109,35 @@ These settings control localization and file locations.
 
 ## Example `config.yaml`
 
-Here is an example of a complete configuration file with comments explaining each section. You can edit this file directly to change settings at any time.
+Here is an example of a complete configuration file. You can edit this file directly to change settings at any time.
 
 ```yaml Example config.yaml icon=logos:yaml
 # Project information for documentation publishing
 projectName: AIGNE DocSmith
-projectDesc: A powerful, AI-driven documentation generation tool.
+projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
 # Documentation Configuration
 # =============================================================================
 
-# Purpose: What's the main outcome you want readers to achieve?
-# Available options (uncomment and modify as needed):
-#   getStarted       - Get started quickly: Help new users go from zero to working in <30 minutes
-#   completeTasks    - Complete specific tasks: Guide users through common workflows and use cases
-#   findAnswers      - Find answers fast: Provide searchable reference for all features and APIs
-#   understandSystem - Understand the system: Explain how it works, why design decisions were made
-#   solveProblems    - Troubleshoot common issues: Help users troubleshoot and fix issues
-#   mixedPurpose     - Serve multiple purposes: Comprehensive documentation covering multiple needs
+# Purpose: What is the main outcome you want readers to achieve?
+# Options: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
 documentPurpose:
   - completeTasks
   - findAnswers
 
 # Target Audience: Who will be reading this most often?
-# Available options (uncomment and modify as needed):
-#   endUsers         - End users (non-technical): People who use the product but don't code
-#   developers       - Developers integrating your product/API: Engineers adding this to their projects
-#   devops           - DevOps / SRE / Infrastructure teams: Teams deploying, monitoring, maintaining systems
-#   decisionMakers   - Technical decision makers: Architects, leads evaluating or planning implementation
-#   supportTeams     - Support teams: People helping others use the product
-#   mixedTechnical   - Mixed technical audience: Developers, DevOps, and technical users
+# Options: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
 targetAudienceTypes:
   - developers
 
 # Reader Knowledge Level: What do readers typically know when they arrive?
-# Available options (uncomment and modify as needed):
-#   completeBeginners    - Is a total beginner, starting from scratch: New to this domain/technology entirely
-#   domainFamiliar       - Has used similar tools before: Know the problem space, new to this specific solution
-#   experiencedUsers     - Is an expert trying to do something specific: Regular users needing reference/advanced topics
-#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
-#   exploringEvaluating  - Is evaluating this tool against others: Trying to understand if this fits their needs
+# Options: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
 # Documentation Depth: How comprehensive should the documentation be?
-# Available options (uncomment and modify as needed):
-#   essentialOnly      - Essential only: Cover the 80% use cases, keep it concise
-#   balancedCoverage   - Balanced coverage: Good depth with practical examples [RECOMMENDED]
-#   comprehensive      - Comprehensive: Cover all features, edge cases, and advanced scenarios
-#   aiDecide           - Let AI decide: Analyze code complexity and suggest appropriate depth
+# Options: essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
 # Custom Rules: Define specific documentation generation rules and requirements
@@ -169,15 +148,22 @@ rules: |+
 targetAudience: |+
   
 
-# Glossary: Define project-specific terms and definitions
-# glossary: "@glossary.md"  # Path to markdown file containing glossary definitions
+# Glossary: Path to markdown file containing project-specific terms and definitions
+# glossary: "@glossary.md"
 
+# Primary language for the documentation
 locale: en
-# translateLanguages:  # List of languages to translate the documentation to
-#   - zh  # Example: Chinese translation
-#   - fr  # Example: French translation
-docsDir: .aigne/doc-smith/docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
+
+# List of languages to translate the documentation into
+# translateLanguages:
+#   - zh
+#   - fr
+
+# Directory to save generated documentation
+docsDir: .aigne/doc-smith/docs
+
+# Source code paths to analyze
+sourcesPath:
   - ./
 ```
 

package/docs/configuration.zh.md

@@ -1,8 +1,8 @@
 # 配置指南
 
-AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件通常位于 `.aigne/doc-smith/config.yaml`。此文件规定了文档的风格、目标受众、语言和结构。
+AIGNE DocSmith 的行为由一个位于 `.aigne/doc-smith/config.yaml` 的核心文件 `config.yaml` 控制。该文件决定了文档的风格、目标受众、语言和结构。
 
-你可以通过运行 `aigne doc init`，使用交互式设置向导来创建和管理此文件。有关分步指南，请参阅[交互式设置](./configuration-interactive-setup.md)指南。
+你可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。
 
 ## 核心配置区域
 
@@ -10,7 +10,7 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 
 <x-cards data-columns="2">
   <x-card data-title="交互式设置" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
-    了解引导式向导，它能帮助你从头开始配置文档项目，包括设置建议。
+    了解引导式向导如何帮助你配置文档项目，包括设置建议和冲突检测。
   </x-card>
   <x-card data-title="LLM 设置" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
     了解如何连接不同的 AI 模型，包括使用无需 API 密钥的内置 AIGNE Hub。
@@ -29,12 +29,12 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 
 ### 项目信息
 
-这些设置提供了关于你项目的基本背景信息，用于发布文档。
+这些设置提供了关于项目的基本背景信息，用于发布文档。
 
 | Parameter | Description |
 |---|---|
-| `projectName` | 你的项目名称。如果 `package.json` 文件存在，则自动从中检测。 |
-| `projectDesc` | 你的项目的简短描述。自动从 `package.json` 检测。 |
+| `projectName` | 你的项目名称。如果可用，将从 `package.json` 中检测。 |
+| `projectDesc` | 你的项目的简短描述。从 `package.json` 中检测。 |
 | `projectLogo` | 你的项目徽标图片的路径或 URL。 |
 
 ### 文档策略
@@ -42,23 +42,23 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 这些参数定义了生成内容的基调、风格和深度。
 
 #### `documentPurpose`
-你希望读者实现的主要成果是什么？此设置会影响文档的整体结构和重点。
+定义你希望读者达到的主要成果。此设置会影响文档的整体结构和重点。
 
 | Option | Name | Description |
 |---|---|---|
 | `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
-| `completeTasks` | 完成特定任务 | 引导用户完成常见工作流和用例。 |
+| `completeTasks` | 完成特定任务 | 引导用户完成常见工作流程和用例。 |
 | `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
 | `understandSystem`| 理解系统 | 解释其工作原理以及做出设计决策的原因。 |
-| `solveProblems` | 排查常见问题 | 帮助用户排查和修复问题。 |
+| `solveProblems` | 解决常见问题 | 帮助用户排查和修复问题。 |
 | `mixedPurpose` | 服务于多种目的 | 涵盖多种需求的文档。 |
 
 #### `targetAudienceTypes`
-谁会最常阅读这份文档？这个选择会影响写作风格和示例。
+定义最常阅读此文档的受众。此选择会影响写作风格和示例。
 
 | Option | Name | Description |
 |---|---|---|
-| `endUsers` | 最终用户（非技术人员） | 使用产品但不编写代码的人员。 |
+| `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
 | `developers` | 集成你的产品/API 的开发者 | 将此添加到其项目中的工程师。 |
 | `devops` | DevOps / SRE / 基础设施团队 | 部署、监控和维护系统的团队。 |
 | `decisionMakers`| 技术决策者 | 评估或规划实施的架构师或负责人。 |
@@ -66,25 +66,25 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 | `mixedTechnical`| 混合技术受众 | 开发者、DevOps 和其他技术用户。 |
 
 #### `readerKnowledgeLevel`
-读者通常具备哪些知识？这会调整所假定的基础知识水平。
+定义读者通常具备的知识水平。这会调整对基础知识的假设程度。
 
 | Option | Name | Description |
 |---|---|---|
-| `completeBeginners` | 完全的初学者，从零开始 | 完全不了解此领域/技术。 |
-| `domainFamiliar` | 之前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
-| `experiencedUsers` | 希望完成特定任务的专家 | 需要参考或高级主题的普通用户。 |
+| `completeBeginners` | 完全的初学者，从零开始 | 完全不熟悉此领域/技术。 |
+| `domainFamiliar` | 之前使用过类似工具 | 了解问题领域，但对这个特定解决方案不熟悉。 |
+| `experiencedUsers` | 试图做特定事情的专家 | 需要参考或高级主题的常规用户。 |
 | `emergencyTroubleshooting`| 紧急情况/故障排查 | 出现问题，需要快速修复。 |
 | `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否符合他们的需求。 |
 
 #### `documentationDepth`
-文档应有多全面？
+定义文档应达到的全面程度。
 
 | Option | Name | Description |
 |---|---|---|
-| `essentialOnly` | 仅包含核心内容 | 覆盖 80% 的用例，保持简洁。 |
+| `essentialOnly` | 仅限基本内容 | 涵盖 80% 的用例，保持简洁。 |
 | `balancedCoverage`| 均衡覆盖 | 具有良好深度和实际示例 [推荐]。 |
-| `comprehensive` | 全面 | 覆盖所有功能、边缘情况和高级场景。 |
-| `aiDecide` | 由 AI 决定 | 分析代码复杂性并建议合适的深度。 |
+| `comprehensive` | 全面 | 涵盖所有功能、边缘情况和高级场景。 |
+| `aiDecide` | 让 AI 决定 | 分析代码复杂性并建议适当的深度。 |
 
 ### 自定义指令
 
@@ -92,8 +92,8 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 
 | Parameter | Description |
 |---|---|
-| `rules` | 一个多行字符串，你可以在其中定义具体的文档生成规则和要求（例如，“始终包含性能基准测试”）。 |
-| `targetAudience`| 一个多行字符串，用于比预设更详细地描述你的特定目标受众及其特征。 |
+| `rules` | 一个多行字符串，你可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
+| `targetAudience`| 一个多行字符串，用于比预设更详细地描述你的特定目标受众。 |
 
 ### 语言和路径配置
 
@@ -101,7 +101,7 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 
 | Parameter | Description |
 |---|---|
-| `locale` | 文档的主要语言（例如，`en`、`zh`）。 |
+| `locale` | 文档的主语言（例如，`en`、`zh`）。 |
 | `translateLanguages` | 要将文档翻译成的语言代码列表（例如，`[ja, fr, es]`）。 |
 | `docsDir` | 保存生成的文档文件的目录。 |
 | `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
@@ -109,59 +109,38 @@ AIGNE DocSmith 的行为由一个中心文件 `config.yaml` 控制，该文件
 
 ## config.yaml 示例
 
-这是一个完整的配置文件示例，其中包含解释每个部分的注释。你可以随时直接编辑此文件以更改设置。
+这是一个完整的配置文件示例。你可以随时直接编辑此文件以更改设置。
 
 ```yaml Example config.yaml icon=logos:yaml
 # 用于文档发布的项目信息
 projectName: AIGNE DocSmith
-projectDesc: A powerful, AI-driven documentation generation tool.
+projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
 # 文档配置
 # =============================================================================
 
-# 目的：你希望读者实现的主要成果是什么？
-# 可用选项（根据需要取消注释并修改）：
-#   getStarted       - 快速入门：帮助新用户在 30 分钟内从零开始上手
-#   completeTasks    - 完成特定任务：引导用户完成常见工作流和用例
-#   findAnswers      - 快速查找答案：为所有功能和 API 提供可搜索的参考
-#   understandSystem - 理解系统：解释其工作原理以及做出设计决策的原因
-#   solveProblems    - 排查常见问题：帮助用户排查和修复问题
-#   mixedPurpose     - 服务于多种目的：涵盖多种需求的综合性文档
+# 目的：你希望读者达到的主要成果是什么？
+# 选项：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
 documentPurpose:
   - completeTasks
   - findAnswers
 
-# 目标受众：谁会最常阅读这份文档？
-# 可用选项（根据需要取消注释并修改）：
-#   endUsers         - 最终用户（非技术人员）：使用产品但不编写代码的人员
-#   developers       - 集成你的产品/API 的开发者：将此添加到其项目中的工程师
-#   devops           - DevOps / SRE / 基础设施团队：部署、监控、维护系统的团队
-#   decisionMakers   - 技术决策者：评估或规划实施的架构师、负责人
-#   supportTeams     - 支持团队：帮助他人使用产品的人员
-#   mixedTechnical   - 混合技术受众：开发者、DevOps 和技术用户
+# 目标受众：谁会最常阅读此文档？
+# 选项：endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
 targetAudienceTypes:
   - developers
 
-# 读者知识水平：读者通常具备哪些知识？
-# 可用选项（根据需要取消注释并修改）：
-#   completeBeginners    - 完全的初学者，从零开始：完全不了解此领域/技术
-#   domainFamiliar       - 之前使用过类似的工具：了解问题领域，但对这个具体解决方案不熟悉
-#   experiencedUsers     - 希望完成特定任务的专家：需要参考/高级主题的普通用户
-#   emergencyTroubleshooting - 紧急情况/故障排查：出现问题，需要快速修复
-#   exploringEvaluating  - 正在评估此工具并与其他工具进行比较：试图了解这是否符合他们的需求
+# 读者知识水平：读者通常具备什么知识？
+# 选项：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
-# 文档深度：文档应有多全面？
-# 可用选项（根据需要取消注释并修改）：
-#   essentialOnly      - 仅包含核心内容：覆盖 80% 的用例，保持简洁
-#   balancedCoverage   - 均衡覆盖：具有良好深度和实际示例 [推荐]
-#   comprehensive      - 全面：覆盖所有功能、边缘情况和高级场景
-#   aiDecide           - 由 AI 决定：分析代码复杂性并建议合适的深度
+# 文档深度：文档应该有多全面？
+# 选项：essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
-# 自定义规则：定义具体的文档生成规则和要求
+# 自定义规则：定义特定的文档生成规则和要求
 rules: |+
   
 
@@ -169,18 +148,25 @@ rules: |+
 targetAudience: |+
   
 
-# 术语表：定义项目特定的术语和定义
-# glossary: "@glossary.md"  # 包含术语表定义的 markdown 文件路径
+# 术语表：包含项目特定术语和定义的 markdown 文件的路径
+# glossary: "@glossary.md"
 
+# 文档的主语言
 locale: en
-# translateLanguages:  # 要将文档翻译成的语言列表
-#   - zh  # 示例：中文翻译
-#   - fr  # 示例：法语翻译
-docsDir: .aigne/doc-smith/docs  # 保存生成的文档的目录
-sourcesPath:  # 要分析的源代码路径
+
+# 要将文档翻译成的语言列表
+# translateLanguages:
+#   - zh
+#   - fr
+
+# 保存生成的文档的目录
+docsDir: .aigne/doc-smith/docs
+
+# 要分析的源代码路径
+sourcesPath:
   - ./
 ```
 
-配置设置完成后，你就可以创建符合项目需求的文档了。下一步是运行生成命令。
+完成配置后，你就可以创建符合项目需求的文档了。下一步是运行生成命令。
 
 ➡️ **下一步：** [生成文档](./features-generate-documentation.md)

package/docs/features-generate-documentation.md

@@ -1,8 +1,6 @@
 # Generate Documentation
 
-The `aigne doc generate` command is the core function of DocSmith, designed to transform your source code into a structured documentation suite with a single command.
-
-This process analyzes your codebase, plans a logical document structure, and then generates content for each section. It's the primary way to create your documentation from scratch.
+The `aigne doc generate` command is the core function for creating a complete documentation set from your source code. This process analyzes your codebase, plans a logical document structure, and then generates content for each section. It's the primary way to create your documentation from scratch.
 
 ## Your First Generation
 
@@ -14,17 +12,18 @@ aigne doc generate
 
 ### Automatic Configuration
 
-If you're running this command for the first time in a project, DocSmith will detect that no configuration exists. It will automatically launch an interactive setup wizard to guide you through the initial setup. This ensures you have a properly configured environment before generation begins.
+If you run this command for the first time in a project, DocSmith detects that no configuration exists. It will then launch an interactive setup wizard to guide you through the initial setup. This ensures you have a properly configured environment before generation begins.
 
 ![Running the generate command for the first time triggers the setup wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
 You will be asked a series of questions to define:
+
 - Document generation rules and style
 - The target audience
 - Primary and translation languages
 - Source code and output paths
 
-![Answer a few questions to configure your documentation style, languages, and source paths](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+![Answer the questions to configure your documentation style, languages, and source paths](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
 
 Once the configuration is complete, DocSmith proceeds with the documentation generation.
 
@@ -36,7 +35,7 @@ Upon successful completion, your newly created documentation will be available i
 
 ## The Generation Process
 
-The `generate` command follows an automated workflow to ensure consistent results. The process can be visualized as follows:
+The `generate` command follows an automated workflow. The process can be visualized as follows:
 
 ```d2
 direction: down
@@ -98,5 +97,5 @@ While the default `generate` command is sufficient for most use cases, you can u
 Now that you have generated your initial documentation, your project will continue to evolve. To keep your documents synchronized with your code, you will need to update them. Proceed to the next section to learn how to make targeted changes and regenerate specific files.
 
 <x-card data-title="Update and Refine" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
-  Discover how to update documents when your code changes or make specific improvements using feedback.
+  Learn how to update documents when your code changes or make specific improvements using feedback.
 </x-card>