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

package/docs/configuration.zh-TW.md

@@ -2,7 +2,7 @@
 
 AIGNE DocSmith 的行為由一個中央設定檔 `.aigne/doc-smith/config.yaml` 控制。此檔案可讓您自訂文件的風格、目標受眾、語言和結構，以滿足您的特定需求。
 
-您可以透過執行 `aigne doc init`，使用互動式設定精靈來建立和管理此檔案。如需逐步解說，請參閱 [互動式設定](./configuration-interactive-setup.md) 指南。或者，您也可以直接編輯檔案以進行更精細的控制。
+您可以透過執行 `aigne doc init`，使用互動式設定精靈來建立和管理此檔案。如需逐步說明，請參閱 [互動式設定](./configuration-interactive-setup.md) 指南。或者，您也可以直接編輯檔案以進行更精細的控制。
 
 下圖說明了設定工作流程：
 
@@ -10,73 +10,56 @@ AIGNE DocSmith 的行為由一個中央設定檔 `.aigne/doc-smith/config.yaml`
 direction: down
 
 User: {
-  label: "使用者"
-  shape: c4-person
+  shape: person
 }
 
 CLI: {
-  label: "`aigne doc init`\n(互動式設定)"
+  label: "執行命令\n'aigne doc init'"
   shape: rectangle
 }
 
-ConfigFile: {
-  label: ".aigne/doc-smith/config.yaml"
+Setup-Wizard: {
+  label: "互動式設定精靈"
   shape: rectangle
-  
-  Project-Info: {
-    label: "專案資訊"
-    shape: rectangle
-  }
-  
-  Doc-Strategy: {
-    label: "文件策略"
-    shape: rectangle
-  }
-  
-  Custom-Directives: {
-    label: "自訂指令"
-    shape: rectangle
-  }
-  
-  Lang-Path: {
-    label: "語言與路徑設定"
-    shape: rectangle
-  }
 }
 
-AIGNE-DocSmith: {
-  label: "AIGNE DocSmith\n(生成過程)"
-  icon: "https://www.arcblock.io/image-bin/uploads/89a24f04c34eca94f26c9dd30aec44fc.png"
+Config-File: {
+  label: ".aigne/doc-smith/config.yaml"
+  shape: rectangle
 }
 
-Generated-Docs: {
-  label: "生成的文件"
-  shape: rectangle
+AIGNE-DocSmith-Engine: {
+  label: "AIGNE DocSmith 引擎"
 }
 
-User -> CLI: "執行"
-CLI -> ConfigFile: "建立 / 修改"
-User -> ConfigFile: "直接編輯"
-ConfigFile -> AIGNE-DocSmith: "控制"
-AIGNE-DocSmith -> Generated-Docs: "產生"
+# 路徑 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 金鑰。
+    探索如何連接不同的 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 管理它們。
+    了解 DocSmith 如何使用您的回饋來建立持續性規則，以及如何透過 CLI 管理它們。
   </x-card>
 </x-cards>
 
@@ -86,12 +69,12 @@ AIGNE-DocSmith -> Generated-Docs: "產生"
 
 ### 專案資訊
 
-這些設定提供您專案的基本背景資訊，用於發佈文件。
+這些設定提供了關於您專案的基本情境，用於發布文件。
 
-| 參數 | 說明 |
+| Parameter | Description |
 |---|---|
 | `projectName` | 您的專案名稱。如果 `package.json` 存在，則會從中偵測。 |
-| `projectDesc` | 您專案的簡短描述。從 `package.json` 偵測。 |
+| `projectDesc` | 您的專案簡短描述。從 `package.json` 偵測。 |
 | `projectLogo` | 您專案標誌圖片的路徑或 URL。 |
 
 ### 文件策略
@@ -99,77 +82,77 @@ AIGNE-DocSmith -> Generated-Docs: "產生"
 這些參數定義了生成內容的語氣、風格和深度。
 
 #### `documentPurpose`
-定義您希望讀者達成的​​主要成果。此設定會影響文件的整體結構和重點。
+定義您希望讀者達成的最主要成果。此設定會影響文件的整體結構和重點。
 
-| 選項 | 名稱 | 說明 |
+| Option | Name | Description |
 |---|---|---|
-| `getStarted` | 快速入門 | 幫助新使用者在 30 分鐘內從零開始上手。 |
+| `getStarted` | 快速入門 | 幫助新使用者在 <30 分鐘內從零到上手。 |
 | `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
 | `findAnswers` | 快速尋找答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
-| `understandSystem`| 了解系統 | 解釋其運作原理以及為何做出這些設計決策。 |
-| `solveProblems` | 解決常見問題 | 幫助使用者進行故障排除和修復問題。 |
-| `mixedPurpose` | 滿足多種目的 | 涵蓋多種需求的文件。 |
+| `understandSystem`| 了解系統 | 解釋其運作方式以及設計決策的原因。 |
+| `solveProblems` | 解決常見問題 | 幫助使用者排除故障並修復問題。 |
+| `mixedPurpose` | 服務多種目的 | 涵蓋多種需求的文件。 |
 
 #### `targetAudienceTypes`
 定義最常閱讀此文件的對象。此選擇會影響寫作風格和範例。
 
-| 選項 | 名稱 | 說明 |
+| Option | Name | Description |
 |---|---|---|
-| `endUsers` | 終端使用者（非技術人員） | 使用產品但不寫程式的人。 |
-| `developers` | 整合您產品/API 的開發者 | 將此產品加入其專案的工程師。 |
+| `endUsers` | 終端使用者（非技術人員） | 使用產品但不編寫程式的人員。 |
+| `developers` | 整合您產品/API 的開發人員 | 將此產品加入其專案的工程師。 |
 | `devops` | DevOps / SRE / 基礎架構團隊 | 部署、監控和維護系統的團隊。 |
 | `decisionMakers`| 技術決策者 | 評估或規劃實施的架構師或主管。 |
-| `supportTeams` | 支援團隊 | 幫助他人使用產品的人員。 |
-| `mixedTechnical`| 混合技術受眾 | 開發者、DevOps 和其他技術使用者。 |
+| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
+| `mixedTechnical`| 混合技術受眾 | 開發人員、DevOps 和其他技術使用者。 |
 
 #### `readerKnowledgeLevel`
 定義讀者通常具備的知識水平。這會調整文件中假設的基礎知識多寡。
 
-| 選項 | 名稱 | 說明 |
+| Option | Name | Description |
 |---|---|---|
-| `completeBeginners` | 完全的初學者，從零開始 | 完全不熟悉此領域/技術。 |
+| `completeBeginners` | 完全的初學者，從零開始 | 對此領域/技術完全陌生。 |
 | `domainFamiliar` | 曾使用過類似工具 | 了解問題領域，但對此特定解決方案不熟悉。 |
-| `experiencedUsers` | 想做特定事情的專家 | 需要參考資料或進階主題的常規使用者。 |
-| `emergencyTroubleshooting`| 緊急情況/故障排除 | 有東西壞了，需要快速修復。 |
-| `exploringEvaluating` | 正在評估此工具並與其他工具比較 | 試圖了解這是否符合他們的需求。 |
+| `experiencedUsers` | 是專家，想做特定的事情 | 需要參考資料或進階主題的常規使用者。 |
+| `emergencyTroubleshooting`| 緊急/故障排除 | 有東西壞了，需要快速修復。 |
+| `exploringEvaluating` | 正在評估此工具與其他工具的比較 | 試圖了解此工具是否符合他們的需求。 |
 
 #### `documentationDepth`
-定義文件的全面性程度。
+定義文件的全面程度。
 
-| 選項 | 名稱 | 說明 |
+| Option | Name | Description |
 |---|---|---|
-| `essentialOnly` | 僅包含必要內容 | 涵蓋 80% 的使用案例，保持簡潔。 |
-| `balancedCoverage`| 均衡的涵蓋範圍 | 具備良好深度和實用範例 [推薦]。 |
-| `comprehensive` | 全面 | 涵蓋所有功能、邊緣案例和進階情境。 |
+| `essentialOnly` | 僅限必要內容 | 涵蓋 80% 的使用案例，保持簡潔。 |
+| `balancedCoverage`| 均衡涵蓋 | 具備良好深度和實用範例 [建議]。 |
+| `comprehensive` | 全面詳盡 | 涵蓋所有功能、邊界案例和進階情境。 |
 | `aiDecide` | 讓 AI 決定 | 分析程式碼複雜度並建議適當的深度。 |
 
 ### 自訂指令
 
 若要進行更精細的控制，您可以提供自由文字的指令。
 
-| 參數 | 說明 |
+| Parameter | Description |
 |---|---|
-| `rules` | 一個多行字串，您可以在其中定義特定的文件生成規則（例如：「務必包含效能基準測試」）。 |
-| `targetAudience`| 一個多行字串，用來比預設選項更詳細地描述您的特定目標受眾。 |
+| `rules` | 一個多行字串，您可以在其中定義特定的文件生成規則（例如，「務必包含效能基準測試」）。 |
+| `targetAudience`| 一個多行字串，用以比預設選項更詳細地描述您的特定目標受眾。 |
 
 ### 語言與路徑設定
 
 這些設定控制本地化和檔案位置。
 
-| 參數 | 說明 |
+| Parameter | Description |
 |---|---|
-| `locale` | 文件的主要語言（例如：`en`、`zh`）。 |
-| `translateLanguages` | 要將文件翻譯成的語言代碼列表（例如：`[ja, fr, es]`）。 |
-| `docsDir` | 儲存生成文件的目錄。 |
-| `sourcesPath` | 供 DocSmith 分析的原始碼路徑或 glob 模式列表（例如：`['./src', './lib/**/*.js']`）。 |
-| `glossary` | 包含專案特定術語的 markdown 檔案 (`@glossary.md`) 路徑，以確保翻譯一致性。 |
+| `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
-# 文件的專案資訊發佈
+# 文件發布的專案資訊
 projectName: AIGNE DocSmith
 projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
@@ -178,7 +161,7 @@ projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894
 # 文件設定
 # =============================================================================
 
-# 目的：您希望讀者達成的​​主要成果是什麼？
+# 目的：您希望讀者達成的最主要成果是什麼？
 # 選項：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
 documentPurpose:
   - completeTasks
@@ -224,6 +207,6 @@ sourcesPath:
   - ./
 ```
 
-設定完成後，您就可以建立符合專案需求的文件了。下一步是執行生成指令。
+完成設定後，您就可以開始建立符合專案需求的文件了。下一步是執行生成命令。
 
-➡️ **下一步：** [生成文件](./features-generate-documentation.md)
+➡️ **下一步：** [產生文件](./features-generate-documentation.md)

package/docs/configuration.zh.md

@@ -2,87 +2,70 @@
 
 AIGNE DocSmith 的行为由一个中央配置文件 `.aigne/doc-smith/config.yaml` 控制。该文件允许您自定义文档的风格、目标受众、语言和结构，以满足您的特定需求。
 
-您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。或者，您可以直接编辑该文件以进行更精细的控制。
+您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。此外，您也可以直接编辑该文件以进行更精细的控制。
 
 下图说明了配置工作流程：
 
-```d2 配置工作流
+```d2 配置工作流程
 direction: down
 
 User: {
-  shape: c4-person
-  label: "用户"
+  shape: person
 }
 
 CLI: {
-  label: "`aigne doc init`\n(交互式设置)"
+  label: "运行命令\n'aigne doc init'"
   shape: rectangle
 }
 
-ConfigFile: {
-  label: ".aigne/doc-smith/config.yaml"
+Setup-Wizard: {
+  label: "交互式设置向导"
   shape: rectangle
-  
-  Project-Info: {
-    label: "项目信息"
-    shape: rectangle
-  }
-  
-  Doc-Strategy: {
-    label: "文档策略"
-    shape: rectangle
-  }
-  
-  Custom-Directives: {
-    label: "自定义指令"
-    shape: rectangle
-  }
-  
-  Lang-Path: {
-    label: "语言和路径配置"
-    shape: rectangle
-  }
 }
 
-AIGNE-DocSmith: {
-  label: "AIGNE DocSmith\n(生成过程)"
-  icon: "https://www.arcblock.io/image-bin/uploads/89a24f04c34eca94f26c9dd30aec44fc.png"
+Config-File: {
+  label: ".aigne/doc-smith/config.yaml"
+  shape: rectangle
 }
 
-Generated-Docs: {
-  label: "生成的文档"
-  shape: rectangle
+AIGNE-DocSmith-Engine: {
+  label: "AIGNE DocSmith 引擎"
 }
 
-User -> CLI: "运行"
-CLI -> ConfigFile: "创建/修改"
-User -> ConfigFile: "直接编辑"
-ConfigFile -> AIGNE-DocSmith: "控制"
-AIGNE-DocSmith -> Generated-Docs: "生成"
+# 路径 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。
+    了解如何连接不同的 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 data-title="管理偏好设置" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
+    了解 DocSmith 如何利用您的反馈创建持久性规则，以及如何通过 CLI 管理这些规则。
   </x-card>
 </x-cards>
 
 ## 参数参考
 
-`config.yaml` 文件包含几个控制文档输出的键值对。以下是每个参数的详细参考。
+`config.yaml` 文件包含多个控制文档输出的键值对。以下是每个参数的详细参考。
 
 ### 项目信息
 
@@ -90,16 +73,16 @@ AIGNE-DocSmith -> Generated-Docs: "生成"
 
 | 参数 | 描述 |
 |---|---|
-| `projectName` | 您的项目名称。如果可用，则从 `package.json` 中检测。 |
-| `projectDesc` | 您的项目的简短描述。从 `package.json` 中检测。 |
-| `projectLogo` | 您的项目徽标图像的路径或 URL。 |
+| `projectName` | 您的项目名称。如果 `package.json` 文件存在，则从中检测。 |
+| `projectDesc` | 您的项目简短描述。从 `package.json` 文件中检测。 |
+| `projectLogo` | 您的项目徽标图片的路径或 URL。 |
 
 ### 文档策略
 
 这些参数定义了生成内容的基调、风格和深度。
 
 #### `documentPurpose`
-定义您希望读者实现的主要成果。此设置会影响文档的整体结构和重点。
+定义您希望读者实现的主要成果。此设置影响文档的整体结构和重点。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
@@ -111,36 +94,36 @@ AIGNE-DocSmith -> Generated-Docs: "生成"
 | `mixedPurpose` | 服务于多种目的 | 涵盖多种需求的文档。 |
 
 #### `targetAudienceTypes`
-定义最常阅读此文档的读者。此选择会影响写作风格和示例。
+定义最常阅读此文档的受众。此选择会影响写作风格和示例。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
 | `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
-| `developers` | 集成您的产品/API 的开发人员 | 将此添加到其项目中的工程师。 |
+| `developers` | 集成您的产品/API 的开发者 | 将此添加到其项目中的工程师。 |
 | `devops` | DevOps / SRE / 基础设施团队 | 部署、监控和维护系统的团队。 |
-| `decisionMakers`| 技术决策者 | 评估或计划实施的架构师或负责人。 |
+| `decisionMakers`| 技术决策者 | 评估或规划实施的架构师或负责人。 |
 | `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
-| `mixedTechnical`| 混合技术受众 | 开发人员、DevOps 和其他技术用户。 |
+| `mixedTechnical`| 混合技术受众 | 开发者、DevOps 和其他技术用户。 |
 
 #### `readerKnowledgeLevel`
-定义读者通常具备的知识水平。这会调整所假定的基础知识量。
+定义读者通常具备的知识水平。这会调整对基础知识的假设程度。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
 | `completeBeginners` | 完全是初学者，从零开始 | 完全不熟悉此领域/技术。 |
-| `domainFamiliar` | 以前使用过类似的工具 | 了解问题领域，但对这个特定解决方案不熟悉。 |
+| `domainFamiliar` | 之前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
 | `experiencedUsers` | 是试图做某件特定事情的专家 | 需要参考或高级主题的常规用户。 |
-| `emergencyTroubleshooting`| 紧急情况/故障排除 | 某些东西坏了，需要快速修复。 |
-| `exploringEvaluating` | 正在将此工具与其他工具进行评估 | 试图了解这是否符合他们的需求。 |
+| `emergencyTroubleshooting`| 紧急情况/故障排查 | 某些东西坏了，需要快速修复。 |
+| `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否符合他们的需求。 |
 
 #### `documentationDepth`
-定义文档应达到的全面程度。
+定义文档的全面程度。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
 | `essentialOnly` | 仅限基本内容 | 覆盖 80% 的用例，保持简洁。 |
 | `balancedCoverage`| 均衡覆盖 | 具有良好深度和实际示例 [推荐]。 |
-| `comprehensive` | 全面 | 覆盖所有功能、边界情况和高级场景。 |
+| `comprehensive` | 全面 | 覆盖所有功能、边缘情况和高级场景。 |
 | `aiDecide` | 让 AI 决定 | 分析代码复杂性并建议适当的深度。 |
 
 ### 自定义指令
@@ -149,8 +132,8 @@ AIGNE-DocSmith -> Generated-Docs: "生成"
 
 | 参数 | 描述 |
 |---|---|
-| `rules` | 一个多行字符串，您可以在其中定义特定的文档生成规则（例如，“始终包含性能基准”）。 |
-| `targetAudience`| 一个多行字符串，用于比预设更详细地描述您的特定目标受众。 |
+| `rules` | 一个多行字符串，您可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
+| `targetAudience`| 一个多行字符串，用于比预设选项更详细地描述您的特定目标受众。 |
 
 ### 语言和路径配置
 
@@ -160,18 +143,18 @@ AIGNE-DocSmith -> Generated-Docs: "生成"
 |---|---|
 | `locale` | 文档的主要语言（例如，`en`、`zh`）。 |
 | `translateLanguages` | 要将文档翻译成的语言代码列表（例如，`[ja, fr, es]`）。 |
-| `docsDir` | 保存生成的文档文件的目录。 |
+| `docsDir` | 生成的文档文件将保存到的目录。 |
 | `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
-| `glossary` | 包含项目特定术语的 markdown 文件（`@glossary.md`）的路径，以确保翻译的一致性。 |
+| `glossary` | 包含项目特定术语的 Markdown 文件（`@glossary.md`）路径，以确保翻译的一致性。 |
 
-## config.yaml 示例
+## `config.yaml` 示例
 
 这是一个完整的配置文件示例。您可以随时直接编辑此文件来更改设置。
 
 ```yaml config.yaml 示例 icon=logos:yaml
 # 用于文档发布的项目信息
 projectName: AIGNE DocSmith
-projectDesc: 一个由 AI 驱动的文档生成工具。
+projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
@@ -193,7 +176,7 @@ targetAudienceTypes:
 # 选项：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
-# 文档深度：文档应达到多大的全面程度？
+# 文档深度：文档应有多全面？
 # 选项：essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
@@ -205,7 +188,7 @@ rules: |+
 targetAudience: |+
   
 
-# 术语表：包含项目特定术语和定义的 markdown 文件的路径
+# 词汇表：包含项目特定术语和定义的 Markdown 文件路径
 # glossary: "@glossary.md"
 
 # 文档的主要语言
@@ -216,7 +199,7 @@ locale: en
 #   - zh
 #   - fr
 
-# 保存生成的文档的目录
+# 保存生成文档的目录
 docsDir: .aigne/doc-smith/docs
 
 # 要分析的源代码路径
@@ -224,6 +207,6 @@ sourcesPath:
   - ./
 ```
 
-配置设置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
+配置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
 
 ➡️ **下一步：** [生成文档](./features-generate-documentation.md)