@aigne/doc-smith 0.8.2 → 0.8.4

package/docs/configuration.md

@@ -1,173 +1,186 @@
----
-labels: ["Reference"]
----
-
 # Configuration Guide
 
-AIGNE DocSmith's behavior is controlled by a single, powerful configuration file: `config.yaml`. This file, located in the `.aigne/doc-smith` directory of your project, allows you to customize every aspect of the documentation generation process—from the intended audience and style to language support and file structure.
+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.
 
-This guide provides a detailed reference for all available settings. While you can edit this file manually at any time, we recommend using the [Interactive Setup](./configuration-interactive-setup.md) wizard for your initial configuration.
+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.
 
-## Configuration Overview
+## Core Configuration Areas
 
-DocSmith offers a flexible configuration system to match your project's unique needs. You can define the goals of your documentation, specify your audience, set up AI models, and manage multiple languages. Explore the key areas of configuration below.
+Your documentation is shaped by several key areas of configuration. Explore these guides to understand how to fine-tune each aspect of the generation process.
 
 <x-cards data-columns="2">
-  <x-card data-title="Interactive Setup" data-href="/configuration/interactive-setup" data-icon="lucide:wand-2">
-    Learn how to use the `aigne doc init` command to run a guided wizard that creates your initial configuration file effortlessly.
+  <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.
   </x-card>
-  <x-card data-title="LLM Setup" data-href="/configuration/llm-setup" data-icon="lucide:brain-circuit">
-    Configure different Large Language Models, including using the integrated AIGNE Hub for key-free access to popular models.
+  <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.
   </x-card>
-  <x-card data-title="Language Support" data-href="/configuration/language-support" data-icon="lucide:languages">
-    Set your primary documentation language and choose from over 12 supported languages for automatic translation.
+  <x-card data-title="Language Support" data-icon="lucide:languages" data-href="/configuration/language-support">
+    See the full list of supported languages and learn how to set a primary language and enable automatic translations.
   </x-card>
-  <x-card data-title="Managing Preferences" data-href="/configuration/preferences" data-icon="lucide:sliders-horizontal">
-    Understand how DocSmith learns from your feedback to create persistent rules and how to manage them.
+  <x-card data-title="Managing Preferences" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
+    Understand how DocSmith uses your feedback to create persistent rules and how to manage them via the CLI.
   </x-card>
 </x-cards>
 
 ## Parameter Reference
 
-The `config.yaml` file contains several key sections that define how your documentation is generated. Below is a comprehensive breakdown of each parameter.
+The `config.yaml` file contains several key-value pairs that control the documentation output. Below is a detailed reference for each parameter.
 
 ### Project Information
 
-These settings are used for display purposes when you publish your documentation.
-
-```yaml
-# Project information for documentation publishing
-projectName: AIGNE DocSmith
-projectDesc: An AI-driven documentation generation tool.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
-```
+These settings provide basic context about your project, which is used when publishing the documentation.
 
-- `projectName`: The name of your project.
-- `projectDesc`: A short description of your project.
-- `projectLogo`: A URL to your project's logo.
+| 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`. |
+| `projectLogo` | A path or URL to your project's logo image. |
 
-### Documentation Style
+### Documentation Strategy
 
-These parameters define the purpose, audience, and overall tone of your documentation.
+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 primary goal for your readers. You can select multiple purposes.
-
-| Key | Name | Description |
+| Option | Name | Description |
 |---|---|---|
 | `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. |
+| `understandSystem`| Understand the system | Explain how it works and why design decisions were made. |
 | `solveProblems` | Troubleshoot common issues | Help users troubleshoot and fix issues. |
-| `mixedPurpose` | Serve multiple purposes | Comprehensive documentation covering multiple needs. |
-
-**Example:**
-```yaml
-documentPurpose:
-  - getStarted
-  - findAnswers
-```
+| `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.
 
-Specifies the primary audience for the documentation.
-
-| Key | Name | Description |
+| Option | Name | Description |
 |---|---|---|
 | `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. |
+| `devops` | DevOps / SRE / Infrastructure teams | Teams deploying, monitoring, and maintaining systems. |
+| `decisionMakers`| Technical decision makers | Architects or leads evaluating or planning implementation. |
 | `supportTeams` | Support teams | People helping others use the product. |
-| `mixedTechnical` | Mixed technical audience | Developers, DevOps, and technical users. |
-
-**Example:**
-```yaml
-targetAudienceTypes:
-  - developers
-```
+| `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.
 
-Describes the typical starting knowledge level of your readers.
-
-| Key | Name | Description |
+| Option | Name | Description |
 |---|---|---|
 | `completeBeginners` | Is a total beginner, starting from scratch | New to this domain/technology entirely. |
-| `domainFamiliar` | Has used similar tools before | Knows 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. |
+| `domainFamiliar` | Has used similar tools before | Knows the problem space, but new to this specific solution. |
+| `experiencedUsers` | Is an expert trying to do something specific | Regular users needing reference or advanced topics. |
+| `emergencyTroubleshooting`| Emergency/troubleshooting | Something is broken and needs to be fixed quickly. |
 | `exploringEvaluating` | Is evaluating this tool against others | Trying to understand if this fits their needs. |
 
-**Example:**
-```yaml
-readerKnowledgeLevel: completeBeginners
-```
-
 #### `documentationDepth`
+How comprehensive should the documentation be?
 
-Controls how comprehensive the documentation should be.
-
-| Key | Name | Description |
+| Option | Name | Description |
 |---|---|---|
-| `essentialOnly` | Essential only | Cover the 80% use cases, keep it concise. |
-| `balancedCoverage` | Balanced coverage | Good depth with practical examples [RECOMMENDED]. |
+| `essentialOnly` | Essential only | Cover the 80% use cases, keeping 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. |
 
-**Example:**
-```yaml
-documentationDepth: balancedCoverage
-```
+### Custom Directives
 
-### Custom Rules & Descriptions
+For more granular control, you can provide free-text instructions.
 
-These fields allow for more specific instructions to the AI.
+| 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 rules and requirements for generation, such as "Always include a 'Prerequisites' section in tutorials."
-- `targetAudience`: A multi-line string to describe your target audience in more detail than the presets allow.
+### Language and Path Configuration
 
-**Example:**
-```yaml
-rules: |
-  - All code examples must be complete and copy-paste ready.
-  - Avoid using technical jargon without explaining it first.
-targetAudience: |
-  Our audience consists of front-end developers who are familiar with JavaScript but may be new to backend concepts. They value clear, practical examples.
-```
+These settings control localization and file locations.
 
-### Language and Path Settings
+| Parameter | Description |
+|---|---|
+| `locale` | The primary language for the documentation (e.g., `en`, `zh`). |
+| `translateLanguages` | A list of language codes to translate the documentation into (e.g., `[ja, fr, es]`). |
+| `docsDir` | The directory where generated documentation files will be saved. |
+| `sourcesPath` | A list of source code paths or glob patterns for DocSmith to analyze (e.g., `['./src', './lib/**/*.js']`). |
+| `glossary` | Path to a markdown file (`@glossary.md`) containing project-specific terms to ensure consistent translations. |
 
-These parameters configure the languages and file locations for your documentation.
+## Example `config.yaml`
 
-- `locale`: The primary language for the documentation (e.g., `en`, `zh`).
-- `translateLanguages`: A list of language codes to translate the documentation into.
-- `glossary`: Path to a Markdown file containing project-specific terms to ensure consistent translations.
-- `docsDir`: The directory where the generated documentation will be saved.
-- `sourcesPath`: A list of source code paths or glob patterns for the AI to analyze.
+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.
 
-**Example:**
-```yaml
-# Language settings
-locale: en
-translateLanguages:
-  - zh
-  - ja
+```yaml Example config.yaml icon=logos:yaml
+# Project information for documentation publishing
+projectName: AIGNE DocSmith
+projectDesc: A powerful, AI-driven documentation generation tool.
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
-# Glossary for consistent terminology
-glossary: "@glossary.md"
+# =============================================================================
+# 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
+documentPurpose:
+  - completeTasks
+  - findAnswers
 
-# Directory and source path configurations
+# 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
+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
+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
+documentationDepth: balancedCoverage
+
+# Custom Rules: Define specific documentation generation rules and requirements
+rules: |+
+  
+
+# Target Audience: Describe your specific target audience and their characteristics
+targetAudience: |+
+  
+
+# Glossary: Define project-specific terms and definitions
+# glossary: "@glossary.md"  # Path to markdown file containing glossary definitions
+
+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
-  - ./src
-  - ./README.md
+  - ./
 ```
 
----
-
-With your `config.yaml` file tailored to your project, you're ready to create your documentation. The next step is to run the generation command.
+With your configuration set, you are ready to create documentation that matches your project's needs. The next step is to run the generation command.
 
-➡️ **Next:** Learn how to [Generate Documentation](./features-generate-documentation.md).
+➡️ **Next:** [Generate Documentation](./features-generate-documentation.md)

package/docs/configuration.zh.md

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