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

package/docs/configuration.zh-TW.md

@@ -1,212 +1,96 @@
-# 設定指南
+# 設定
 
-AIGNE DocSmith 的行為由一個中央設定檔 `.aigne/doc-smith/config.yaml` 控制。此檔案可讓您自訂文件的風格、目標受眾、語言和結構，以滿足您的特定需求。
+正確的設定對於根據專案的特定需求客製化文件產生過程至關重要。AIGNE DocSmith 使用一個主要設定檔和一個命令列介面來管理您的設定。這種設定方式確保產生的文件能準確反映您的專案目標、目標受眾和結構需求。
 
-您可以透過執行 `aigne doc init`，使用互動式設定精靈來建立和管理此檔案。如需逐步說明，請參閱 [互動式設定](./configuration-interactive-setup.md) 指南。或者，您也可以直接編輯檔案以進行更精細的控制。
+本節概述了如何設定此工具。有關逐步說明，請參閱以下詳細指南：
 
-下圖說明了設定工作流程：
-
-```d2 設定工作流程
-direction: down
-
-User: {
-  shape: person
-}
-
-CLI: {
-  label: "執行命令\n'aigne doc init'"
-  shape: rectangle
-}
-
-Setup-Wizard: {
-  label: "互動式設定精靈"
-  shape: rectangle
-}
-
-Config-File: {
-  label: ".aigne/doc-smith/config.yaml"
-  shape: rectangle
-}
-
-AIGNE-DocSmith-Engine: {
-  label: "AIGNE DocSmith 引擎"
-}
-
-# 路徑 1：互動式設定（建議）
-User -> CLI: "建議路徑"
-CLI -> Setup-Wizard: "啟動"
-Setup-Wizard -> Config-File: "建立/修改"
-
-# 路徑 2：手動編輯
-User -> Config-File: "替代路徑：\n直接編輯"
-
-# 最後一步
-Config-File -> AIGNE-DocSmith-Engine: "設定"
-```
-
-## 核心設定區域
-
-您的文件由幾個關鍵的設定區域構成。請探索這些指南，以了解如何微調生成過程的各個方面。
-
-<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 模型，包括使用內建的 AIGNE Hub，無需 API 金鑰。
-  </x-card>
-  <x-card data-title="語言支援" data-icon="lucide:languages" data-href="/configuration/language-support">
-    查看支援的語言完整列表，並了解如何設定主要語言和啟用自動翻譯。
-  </x-card>
-  <x-card data-title="管理偏好設定" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
-    了解 DocSmith 如何使用您的回饋來建立持續性規則，以及如何透過 CLI 管理它們。
-  </x-card>
+<x-cards>
+  <x-card data-title="初始設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何執行互動式設定來建立您的 config.yaml 檔案。這是任何新專案的建議第一步。</x-card>
+  <x-card data-title="管理偏好設定" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何檢視、啟用、停用或刪除已儲存的偏好設定，以隨著時間的推移來完善文件產生過程。</x-card>
 </x-cards>
 
-## 參數參考
-
-`config.yaml` 檔案包含數個控制文件輸出的鍵值對。以下是每個參數的詳細參考。
-
-### 專案資訊
-
-這些設定提供了關於您專案的基本情境，用於發布文件。
-
-| Parameter | Description |
-|---|---|
-| `projectName` | 您的專案名稱。如果 `package.json` 存在，則會從中偵測。 |
-| `projectDesc` | 您的專案簡短描述。從 `package.json` 偵測。 |
-| `projectLogo` | 您專案標誌圖片的路徑或 URL。 |
-
-### 文件策略
-
-這些參數定義了生成內容的語氣、風格和深度。
-
-#### `documentPurpose`
-定義您希望讀者達成的最主要成果。此設定會影響文件的整體結構和重點。
-
-| Option | Name | Description |
-|---|---|---|
-| `getStarted` | 快速入門 | 幫助新使用者在 <30 分鐘內從零到上手。 |
-| `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
-| `findAnswers` | 快速尋找答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
-| `understandSystem`| 了解系統 | 解釋其運作方式以及設計決策的原因。 |
-| `solveProblems` | 解決常見問題 | 幫助使用者排除故障並修復問題。 |
-| `mixedPurpose` | 服務多種目的 | 涵蓋多種需求的文件。 |
-
-#### `targetAudienceTypes`
-定義最常閱讀此文件的對象。此選擇會影響寫作風格和範例。
+## `config.yaml` 檔案
 
-| Option | Name | Description |
-|---|---|---|
-| `endUsers` | 終端使用者（非技術人員） | 使用產品但不編寫程式的人員。 |
-| `developers` | 整合您產品/API 的開發人員 | 將此產品加入其專案的工程師。 |
-| `devops` | DevOps / SRE / 基礎架構團隊 | 部署、監控和維護系統的團隊。 |
-| `decisionMakers`| 技術決策者 | 評估或規劃實施的架構師或主管。 |
-| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
-| `mixedTechnical`| 混合技術受眾 | 開發人員、DevOps 和其他技術使用者。 |
+所有專案層級的設定都儲存在名為 `config.yaml` 的檔案中，該檔案位於您專案內的 `.aigne/doc-smith/` 目錄中。`aigne doc init` 指令會透過一個互動式過程為您建立此檔案。您也可以隨時使用文字編輯器手動修改此檔案以調整設定。
 
-#### `readerKnowledgeLevel`
-定義讀者通常具備的知識水平。這會調整文件中假設的基礎知識多寡。
+以下是一個 `config.yaml` 檔案的範例，其中包含解釋每個區塊的註解。
 
-| Option | Name | Description |
-|---|---|---|
-| `completeBeginners` | 完全的初學者，從零開始 | 對此領域/技術完全陌生。 |
-| `domainFamiliar` | 曾使用過類似工具 | 了解問題領域，但對此特定解決方案不熟悉。 |
-| `experiencedUsers` | 是專家，想做特定的事情 | 需要參考資料或進階主題的常規使用者。 |
-| `emergencyTroubleshooting`| 緊急/故障排除 | 有東西壞了，需要快速修復。 |
-| `exploringEvaluating` | 正在評估此工具與其他工具的比較 | 試圖了解此工具是否符合他們的需求。 |
-
-#### `documentationDepth`
-定義文件的全面程度。
-
-| Option | Name | Description |
-|---|---|---|
-| `essentialOnly` | 僅限必要內容 | 涵蓋 80% 的使用案例，保持簡潔。 |
-| `balancedCoverage`| 均衡涵蓋 | 具備良好深度和實用範例 [建議]。 |
-| `comprehensive` | 全面詳盡 | 涵蓋所有功能、邊界案例和進階情境。 |
-| `aiDecide` | 讓 AI 決定 | 分析程式碼複雜度並建議適當的深度。 |
-
-### 自訂指令
-
-若要進行更精細的控制，您可以提供自由文字的指令。
-
-| Parameter | Description |
-|---|---|
-| `rules` | 一個多行字串，您可以在其中定義特定的文件生成規則（例如，「務必包含效能基準測試」）。 |
-| `targetAudience`| 一個多行字串，用以比預設選項更詳細地描述您的特定目標受眾。 |
-
-### 語言與路徑設定
-
-這些設定控制本地化和檔案位置。
-
-| Parameter | Description |
-|---|---|
-| `locale` | 文件的主要語言（例如 `en`、`zh`）。 |
-| `translateLanguages` | 要將文件翻譯成的語言代碼列表（例如 `[ja, fr, es]`）。 |
-| `docsDir` | 儲存生成文件檔案的目錄。 |
-| `sourcesPath` | 供 DocSmith 分析的原始碼路徑或 glob 模式列表（例如 `['./src', './lib/**/*.js']`）。 |
-| `glossary` | 指向一個 markdown 檔案（`@glossary.md`）的路徑，該檔案包含專案特定術語以確保翻譯的一致性。 |
-
-## config.yaml 範例
-
-這是一個完整的設定檔範例。您可以隨時直接編輯此檔案以更改設定。
-
-```yaml config.yaml 範例 icon=logos:yaml
-# 文件發布的專案資訊
+```yaml Example config.yaml icon=logos:yaml
+# 用於文件發布的專案資訊
 projectName: AIGNE DocSmith
-projectDesc: An AI-driven documentation generation tool.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
 
 # =============================================================================
 # 文件設定
 # =============================================================================
 
 # 目的：您希望讀者達成的最主要成果是什麼？
-# 選項：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+# 可用選項（取消註解並根據需要修改）：
+#   getStarted       - 快速入門：幫助新使用者在 30 分鐘內從零到上手
+#   completeTasks    - 完成特定任務：引導使用者完成常見的工作流程和使用案例
+#   findAnswers      - 快速尋找答案：為所有功能和 API 提供可搜尋的參考資料
+#   understandSystem - 了解系統：解釋其運作方式及設計決策的原因
+#   solveProblems    - 解決問題：幫助使用者進行故障排除並修復問題
+#   mixedPurpose     - 綜合目的：涵蓋多種需求的綜合性文件
 documentPurpose:
+  - getStarted
   - completeTasks
-  - findAnswers
 
-# 目標受眾：誰最常閱讀此文件？
-# 選項：endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+# 目標受眾：誰會最常閱讀這份文件？
+# 可用選項（取消註解並根據需要修改）：
+#   endUsers         - 終端使用者（非技術人員）：使用產品但不寫程式的人
+#   developers       - 整合開發者：將此產品加入其專案的工程師
+#   devops           - DevOps/基礎設施：部署、監控、維護系統的團隊
+#   decisionMakers   - 技術決策者：評估或規劃實施的架構師、領導者
+#   supportTeams     - 支援團隊：幫助他人使用產品的人員
+#   mixedTechnical   - 混合技術受眾：開發者、DevOps 和技術使用者
 targetAudienceTypes:
-  - developers
-
-# 讀者知識水平：讀者通常具備什麼知識？
-# 選項：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
-readerKnowledgeLevel: domainFamiliar
-
-# 文件深度：文件應該有多全面？
-# 選項：essentialOnly, balancedCoverage, comprehensive, aiDecide
-documentationDepth: balancedCoverage
-
-# 自訂規則：定義特定的文件生成規則和要求
-rules: |+
-  
+  - endUsers
+
+# 讀者知識水平：讀者在閱讀文件時通常具備哪些知識？
+# 可用選項（取消註解並根據需要修改）：
+#   completeBeginners    - 完全初學者：對此領域/技術完全陌生
+#   domainFamiliar       - 熟悉領域，工具新手：了解問題領域，但對此特定解決方案不熟
+#   experiencedUsers     - 有經驗的使用者：需要參考資料/進階主題的常規使用者
+#   emergencyTroubleshooting - 緊急/故障排除：出現問題，需要快速修復
+#   exploringEvaluating  - 探索/評估：試圖了解這是否符合他們的需求
+readerKnowledgeLevel: completeBeginners
+
+# 文件深度：文件應該要多詳盡？
+# 可用選項（取消註解並根據需要修改）：
+#   essentialOnly      - 僅涵蓋必要內容：涵蓋 80% 的使用案例，保持簡潔
+#   balancedCoverage   - 平衡的涵蓋範圍：具有足夠深度和實用範例 [建議]
+#   comprehensive      - 全面詳盡：涵蓋所有功能、邊界案例和進階情境
+#   aiDecide           - 讓 AI 決定：分析程式碼複雜度並建議適當的深度
+documentationDepth: comprehensive
+
+# 自訂規則：定義特定的文件產生規則與要求
+rules: |
+  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
+  Focus on concrete, verifiable facts and information.
+  Must cover all subcommands of DocSmith
 
 # 目標受眾：描述您的特定目標受眾及其特徵
-targetAudience: |+
-  
-
-# 詞彙表：包含專案特定術語和定義的 markdown 檔案路徑
-# glossary: "@glossary.md"
+targetAudience: |
 
-# 文件的主要語言
 locale: en
-
-# 要將文件翻譯成的語言列表
-# translateLanguages:
-#   - zh
-#   - fr
-
-# 儲存生成文件的目錄
-docsDir: .aigne/doc-smith/docs
-
-# 要分析的原始碼路徑
-sourcesPath:
-  - ./
+translateLanguages:
+  - zh
+  - zh-TW
+  - ja
+docsDir: ./docs  # 儲存產生文件的目錄
+sourcesPath:  # 要分析的原始碼路徑
+  - ./README.md
+  - ./CHANGELOG.md
+  - ./aigne.yaml
+  - ./agents
+  - ./media.md
+  - ./.aigne/doc-smith/config.yaml
 ```
 
-完成設定後，您就可以開始建立符合專案需求的文件了。下一步是執行生成命令。
+## 總結
+
+完成設定後，此工具將清楚了解您的專案、受眾和文件目標，從而產生更準確、更相關的內容。
 
-➡️ **下一步：** [產生文件](./features-generate-documentation.md)
+若要開始設定您的專案，請前往 [初始設定](./configuration-initial-setup.md) 指南。

package/docs/configuration.zh.md

@@ -1,212 +1,96 @@
-# 配置指南
+# 配置
 
-AIGNE DocSmith 的行为由一个中央配置文件 `.aigne/doc-smith/config.yaml` 控制。该文件允许您自定义文档的风格、目标受众、语言和结构，以满足您的特定需求。
+合理的配置对于根据项目的具体需求定制文档生成过程至关重要。AIGNE DocSmith 使用一个主配置文件和命令行界面来管理您的设置。这种设置确保了生成的文档能够准确反映您的项目目标、目标受众和结构要求。
 
-您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。此外，您也可以直接编辑该文件以进行更精细的控制。
+本节概述了如何配置该工具。有关分步说明，请参阅以下详细指南：
 
-下图说明了配置工作流程：
-
-```d2 配置工作流程
-direction: down
-
-User: {
-  shape: person
-}
-
-CLI: {
-  label: "运行命令\n'aigne doc init'"
-  shape: rectangle
-}
-
-Setup-Wizard: {
-  label: "交互式设置向导"
-  shape: rectangle
-}
-
-Config-File: {
-  label: ".aigne/doc-smith/config.yaml"
-  shape: rectangle
-}
-
-AIGNE-DocSmith-Engine: {
-  label: "AIGNE DocSmith 引擎"
-}
-
-# 路径 1：交互式设置（推荐）
-User -> CLI: "推荐路径"
-CLI -> Setup-Wizard: "启动"
-Setup-Wizard -> Config-File: "创建/修改"
-
-# 路径 2：手动编辑
-User -> Config-File: "备用路径：\n直接编辑"
-
-# 最后一步
-Config-File -> AIGNE-DocSmith-Engine: "配置"
-```
-
-## 核心配置区域
-
-您的文档由几个关键的配置区域决定。请浏览这些指南，了解如何微调生成过程的各个方面。
-
-<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。
-  </x-card>
-  <x-card data-title="语言支持" data-icon="lucide:languages" data-href="/configuration/language-support">
-    查看支持的语言完整列表，并了解如何设置主语言和启用自动翻译。
-  </x-card>
-  <x-card data-title="管理偏好设置" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
-    了解 DocSmith 如何利用您的反馈创建持久性规则，以及如何通过 CLI 管理这些规则。
-  </x-card>
+<x-cards>
+  <x-card data-title="初始设置" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何运行交互式设置来创建您的 config.yaml 文件。这是任何新项目的推荐第一步。</x-card>
+  <x-card data-title="管理偏好设置" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何查看、启用、禁用或删除已保存的偏好设置，以便随着时间的推移优化文档生成过程。</x-card>
 </x-cards>
 
-## 参数参考
-
-`config.yaml` 文件包含多个控制文档输出的键值对。以下是每个参数的详细参考。
-
-### 项目信息
-
-这些设置提供了有关您项目的基本背景信息，用于发布文档。
-
-| 参数 | 描述 |
-|---|---|
-| `projectName` | 您的项目名称。如果 `package.json` 文件存在，则从中检测。 |
-| `projectDesc` | 您的项目简短描述。从 `package.json` 文件中检测。 |
-| `projectLogo` | 您的项目徽标图片的路径或 URL。 |
-
-### 文档策略
-
-这些参数定义了生成内容的基调、风格和深度。
-
-#### `documentPurpose`
-定义您希望读者实现的主要成果。此设置影响文档的整体结构和重点。
-
-| 选项 | 名称 | 描述 |
-|---|---|---|
-| `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
-| `completeTasks` | 完成特定任务 | 引导用户完成常见的工作流程和用例。 |
-| `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
-| `understandSystem`| 理解系统 | 解释其工作原理以及做出设计决策的原因。 |
-| `solveProblems` | 排查常见问题 | 帮助用户排查和修复问题。 |
-| `mixedPurpose` | 服务于多种目的 | 涵盖多种需求的文档。 |
+## `config.yaml` 文件
 
-#### `targetAudienceTypes`
-定义最常阅读此文档的受众。此选择会影响写作风格和示例。
+所有项目级别的设置都存储在名为 `config.yaml` 的文件中，该文件位于您项目中的 `.aigne/doc-smith/` 目录内。`aigne doc init` 命令通过一个交互式过程为您创建此文件。您也可以随时使用文本编辑器手动修改此文件以调整设置。
 
-| 选项 | 名称 | 描述 |
-|---|---|---|
-| `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
-| `developers` | 集成您的产品/API 的开发者 | 将此添加到其项目中的工程师。 |
-| `devops` | DevOps / SRE / 基础设施团队 | 部署、监控和维护系统的团队。 |
-| `decisionMakers`| 技术决策者 | 评估或规划实施的架构师或负责人。 |
-| `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
-| `mixedTechnical`| 混合技术受众 | 开发者、DevOps 和其他技术用户。 |
+以下是一个 `config.yaml` 文件的示例，其中包含解释每个部分的注释。
 
-#### `readerKnowledgeLevel`
-定义读者通常具备的知识水平。这会调整对基础知识的假设程度。
-
-| 选项 | 名称 | 描述 |
-|---|---|---|
-| `completeBeginners` | 完全是初学者，从零开始 | 完全不熟悉此领域/技术。 |
-| `domainFamiliar` | 之前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
-| `experiencedUsers` | 是试图做某件特定事情的专家 | 需要参考或高级主题的常规用户。 |
-| `emergencyTroubleshooting`| 紧急情况/故障排查 | 某些东西坏了，需要快速修复。 |
-| `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否符合他们的需求。 |
-
-#### `documentationDepth`
-定义文档的全面程度。
-
-| 选项 | 名称 | 描述 |
-|---|---|---|
-| `essentialOnly` | 仅限基本内容 | 覆盖 80% 的用例，保持简洁。 |
-| `balancedCoverage`| 均衡覆盖 | 具有良好深度和实际示例 [推荐]。 |
-| `comprehensive` | 全面 | 覆盖所有功能、边缘情况和高级场景。 |
-| `aiDecide` | 让 AI 决定 | 分析代码复杂性并建议适当的深度。 |
-
-### 自定义指令
-
-为了进行更精细的控制，您可以提供自由文本指令。
-
-| 参数 | 描述 |
-|---|---|
-| `rules` | 一个多行字符串，您可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
-| `targetAudience`| 一个多行字符串，用于比预设选项更详细地描述您的特定目标受众。 |
-
-### 语言和路径配置
-
-这些设置控制本地化和文件位置。
-
-| 参数 | 描述 |
-|---|---|
-| `locale` | 文档的主要语言（例如，`en`、`zh`）。 |
-| `translateLanguages` | 要将文档翻译成的语言代码列表（例如，`[ja, fr, es]`）。 |
-| `docsDir` | 生成的文档文件将保存到的目录。 |
-| `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
-| `glossary` | 包含项目特定术语的 Markdown 文件（`@glossary.md`）路径，以确保翻译的一致性。 |
-
-## `config.yaml` 示例
-
-这是一个完整的配置文件示例。您可以随时直接编辑此文件来更改设置。
-
-```yaml config.yaml 示例 icon=logos:yaml
+```yaml Example config.yaml icon=logos:yaml
 # 用于文档发布的项目信息
 projectName: AIGNE DocSmith
-projectDesc: An AI-driven documentation generation tool.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+projectDesc: AIGNE DocSmith 是一款功能强大、由 AI 驱动的文档生成工具，构建于 AIGNE 框架之上。它可以直接从您的源代码中自动创建详细、结构化和多语言的文档。
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
 
 # =============================================================================
 # 文档配置
 # =============================================================================
 
 # 目的：您希望读者实现的主要成果是什么？
-# 选项：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+# 可用选项（取消注释并根据需要修改）：
+#   getStarted       - 快速入门：帮助新用户在 30 分钟内从零开始上手
+#   completeTasks    - 完成特定任务：引导用户了解常见工作流程和用例
+#   findAnswers      - 快速查找答案：为所有功能和 API 提供可搜索的参考
+#   understandSystem - 理解系统：解释其工作原理以及做出设计决策的原因
+#   solveProblems    - 解决问题：帮助用户排查和修复问题
+#   mixedPurpose     - 多种目的混合：涵盖多种需求的综合文档
 documentPurpose:
+  - getStarted
   - completeTasks
-  - findAnswers
 
-# 目标受众：谁会最常阅读此文档？
-# 选项：endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+# 目标受众：谁会最常阅读这些文档？
+# 可用选项（取消注释并根据需要修改）：
+#   endUsers         - 最终用户（非技术人员）：使用产品但不编码的人
+#   developers       - 集成开发者：将此添加到其项目中的工程师
+#   devops           - DevOps/基础设施：部署、监控、维护系统的团队
+#   decisionMakers   - 技术决策者：评估或规划实施的架构师、负责人
+#   supportTeams     - 支持团队：帮助他人使用产品的人
+#   mixedTechnical   - 混合技术受众：开发者、DevOps 和技术用户
 targetAudienceTypes:
-  - developers
+  - endUsers
 
 # 读者知识水平：读者通常具备哪些知识？
-# 选项：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
-readerKnowledgeLevel: domainFamiliar
+# 可用选项（取消注释并根据需要修改）：
+#   completeBeginners    - 完全初学者：完全不熟悉该领域/技术
+#   domainFamiliar       - 熟悉领域，但工具是新的：了解问题领域，但对这个特定解决方案不熟悉
+#   experiencedUsers     - 经验丰富的用户：需要参考/高级主题的常规用户
+#   emergencyTroubleshooting - 紧急/故障排除：出现问题，需要快速修复
+#   exploringEvaluating  - 探索/评估：试图了解这是否满足他们的需求
+readerKnowledgeLevel: completeBeginners
 
 # 文档深度：文档应有多全面？
-# 选项：essentialOnly, balancedCoverage, comprehensive, aiDecide
-documentationDepth: balancedCoverage
-
-# 自定义规则：定义特定的文档生成规则和要求
-rules: |+
-  
-
-# 目标受众：描述您的特定目标受众及其特征
-targetAudience: |+
-  
-
-# 词汇表：包含项目特定术语和定义的 Markdown 文件路径
-# glossary: "@glossary.md"
+# 可用选项（取消注释并根据需要修改）：
+#   essentialOnly      - 仅包含基本内容：覆盖 80% 的用例，保持简洁
+#   balancedCoverage   - 平衡覆盖：具有适当深度和实际示例 [推荐]
+#   comprehensive      - 全面：覆盖所有功能、边缘情况和高级场景
+#   aiDecide           - 让 AI 决定：分析代码复杂性并建议适当的深度
+documentationDepth: comprehensive
+
+# 自定义规则：定义具体的文档生成规则和要求
+rules: |
+  避免使用模糊或空洞的词语，这些词语无法提供可衡量或具体的细节，例如‘智能地’、‘无缝地’、‘全面地’或‘高质量地’。专注于具体、可验证的事实和信息。
+  专注于具体、可验证的事实和信息。
+  必须覆盖 DocSmith 的所有子命令
+
+# 目标受众：描述您的具体目标受众及其特征
+targetAudience: |
 
-# 文档的主要语言
 locale: en
-
-# 要将文档翻译成的语言列表
-# translateLanguages:
-#   - zh
-#   - fr
-
-# 保存生成文档的目录
-docsDir: .aigne/doc-smith/docs
-
-# 要分析的源代码路径
-sourcesPath:
-  - ./
+translateLanguages:
+  - zh
+  - zh-TW
+  - ja
+docsDir: ./docs  # 保存生成文档的目录
+sourcesPath:  # 要分析的源代码路径
+  - ./README.md
+  - ./CHANGELOG.md
+  - ./aigne.yaml
+  - ./agents
+  - ./media.md
+  - ./.aigne/doc-smith/config.yaml
 ```
 
-配置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
+## 总结
+
+完成配置后，该工具将清楚地了解您的项目、受众和文档目标，从而生成更准确、更相关的内容。
 
-➡️ **下一步：** [生成文档](./features-generate-documentation.md)
+要开始设置您的项目，请继续阅读[初始设置](./configuration-initial-setup.md)指南。