@aigne/doc-smith 0.8.12-beta.7 → 0.8.12-beta.8

package/docs/getting-started.zh-TW.md

@@ -1,18 +1,18 @@
-# 開始使用
+# 入門指南
 
-本指南提供安裝 AIGNE DocSmith 並產生第一份文件的逐步流程。整個過程設計得簡單明瞭，可以快速完成。
+本指南提供安裝 AIGNE DocSmith 並產生第一份文件的逐步流程。整個過程設計得相當簡單，幾分鐘內即可完成。
 
-## 前提條件
+## 先決條件
 
-在進行安裝之前，請確保您的系統符合以下要求：
+在開始安裝之前，請確保您的系統符合以下要求：
 
-*   **Node.js**：需要 20 或更新版本。DocSmith 使用 Node Package Manager (npm) 安裝，npm 包含在 Node.js 的安裝中。若要安裝 Node.js，請造訪官方 [Node.js 網站](https://nodejs.org/) 並按照您作業系統的說明進行操作。您可以透過開啟終端機並執行 `node -v` 和 `npm -v` 來驗證安裝。
+*   **Node.js**：需要 20 或更新版本。DocSmith 使用 Node Package Manager (npm) 安裝，npm 已包含在 Node.js 的安裝程式中。若要安裝 Node.js，請造訪官方 [Node.js 網站](https://nodejs.org/) 並依照您作業系統的說明進行操作。您可以開啟終端機並執行 `node -v` 和 `npm -v` 來驗證安裝。
 
-*   **API 金鑰**：開始時不需要任何 API 金鑰。預設情況下，DocSmith 使用 AIGNE Hub 服務進行 AI 驅動的生成，讓您無需直接設定即可使用各種大型語言模型。
+*   **API 金鑰**：開始時不需要任何 API 金鑰。預設情況下，DocSmith 使用 AIGNE Hub 服務進行 AI 驅動的產生，讓您無需直接設定即可使用各種大型語言模型。
 
 ## 安裝
 
-此工具作為 AIGNE 命令列介面 (CLI) 的一部分進行分發。
+此工具是 AIGNE 命令列介面 (CLI) 的一部分。安裝過程包含兩個簡單的步驟。
 
 ### 步驟 1：安裝 AIGNE CLI
 
@@ -22,17 +22,17 @@
 npm install -g @aigne/cli
 ```
 
-此指令會下載並安裝套件，使 `aigne` 指令在任何目錄下都可用。
+此指令會從 npm 登錄檔下載並安裝套件，讓 `aigne` 指令可以在您終端機的任何目錄中使用。
 
 ### 步驟 2：驗證安裝
 
-安裝完成後，請執行文件工具的說明指令來進行驗證：
+安裝完成後，您可以執行文件工具的說明指令來進行驗證：
 
 ```bash title="驗證安裝"
 aigne doc --help
 ```
 
-此指令應會顯示可用的 DocSmith 指令與選項列表，確認安裝成功。
+此指令應會顯示可用的 DocSmith 指令及其選項列表，這表示安裝已成功。
 
 ## 產生您的第一份文件
 
@@ -40,15 +40,15 @@ aigne doc --help
 
 ### 步驟 1：導覽至您的專案目錄
 
-開啟您的終端機，並使用 `cd` 指令將目前目錄切換到您想要建立文件的專案根目錄。
+開啟您的終端機，並使用 `cd` 指令將當前目錄切換到您想要建立文件的專案根目錄。
 
-```bash title="切換目錄" icon=mdi:folder-open
+```bash title="變更目錄" icon=mdi:folder-open
 cd /path/to/your/project
 ```
 
 ### 步驟 2：執行產生指令
 
-執行主要的 `generate` 指令。這個單一指令會處理整個文件建立過程。
+執行主要的 `generate` 指令。這個單一指令能處理從分析到內容產生的整個文件建立過程。
 
 ```bash title="執行產生指令"
 aigne doc generate
@@ -56,33 +56,52 @@ aigne doc generate
 
 ### 步驟 3：完成互動式設定
 
-當您第一次在專案中執行 `generate` 指令時，DocSmith 將啟動一次性的互動式設定流程。系統會詢問您一系列問題來設定您的文件偏好，例如其主要目的、目標受眾和語言。設定完成後，將會在 `.aigne/doc-smith` 目錄中建立一個 `config.yaml` 檔案來儲存您的設定。
+當您第一次在專案中執行 `generate` 指令時，DocSmith 將啟動一次性的互動式設定流程。系統將引導您回答一系列問題，以設定您的文件偏好，例如其主要目的、目標受眾和語言。
+
+![互動式設定過程的螢幕截圖](../assets/screenshots/doc-complete-setup.png)
+
+您的回答會儲存到位於 `.aigne/doc-smith` 目錄中的 `config.yaml` 檔案。如果需要，之後可以手動編輯此檔案。
 
 ### 步驟 4：等待產生
 
 設定完成後，DocSmith 將自動執行以下操作：
 
-1.  **分析程式碼庫**：掃描您的原始檔案以了解專案的結構和邏輯。
-2.  **規劃結構**：為文件建立一個邏輯計畫，包含章節和主題。
+1.  **分析程式碼庫**：掃描您的原始碼檔案，以了解專案的結構、功能和邏輯。
+2.  **規劃結構**：為文件建立一個邏輯計畫，概述章節和主題。
 3.  **產生內容**：根據分析和您的設定撰寫文件內容。
 
-完成後，將會出現一則確認訊息，且產生的檔案將位於設定時指定的輸出目錄中（例如 `.aigne/doc-smith/docs`）。
+完成後，將會出現一則確認訊息，且產生的檔案將位於設定時指定的輸出目錄中（預設為 `.aigne/doc-smith/docs`）。
+
+![產生成功後顯示的成功訊息螢幕截圖](../assets/screenshots/doc-generated-successfully.png)
+
+## 探索所有指令
+
+DocSmith 提供了一組指令來管理您文件的完整生命週期。下表列出了所有可用的指令及其功能。
+
+| Command     | Description                                                                                                   |
+| :---------- | :------------------------------------------------------------------------------------------------------------ |
+| `generate`  | 分析程式碼庫並根據設定產生一套完整的文件。               |
+| `update`    | 以互動方式選取並重新產生現有文件的特定部分，通常會附上新的回饋。      |
+| `translate` | 將現有文件翻譯成 12 種支援語言中的一種或多種，例如 `zh` 或 `ja`。       |
+| `publish`   | 將產生的文件發布到一個線上平台，使其可透過 URL 存取。                     |
+| `init`      | 啟動互動式設定精靈，以建立或覆寫 `config.yaml` 設定檔。              |
+| `prefs`     | 顯示 `config.yaml` 檔案中的目前設定。                                      |
 
-## 接下來呢？
+## 下一步是什麼？
 
-您已成功產生第一份文件。以下是管理和強化文件的常見後續步驟：
+您已成功產生第一份文件。以下是管理和增強文件的常見後續步驟：
 
 <x-cards data-columns="2">
   <x-card data-title="更新文件" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
     根據程式碼變更或新需求，修改或重新產生文件的特定部分。
   </x-card>
   <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    將您的文件翻譯成 12 種支援的語言之一，例如中文、西班牙文或德文。
+    將您的文件翻譯成 12 種支援的語言中的任何一種，例如中文、西班牙文或德文。
   </x-card>
   <x-card data-title="發布您的文件" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    將您的文件發布到網路上，供您的團隊或大眾使用。
+    讓您的團隊或大眾可以在線上存取您的文件。
   </x-card>
   <x-card data-title="檢視設定" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    檢視並修改在初始設定期間建立的 config.yaml 檔案，以調整您的偏好設定。
+    檢視並修改在初始設定期間建立的 config.yaml 檔案，以調整您的偏好。
   </x-card>
-</x-cards>
+</x-cards>

package/docs/getting-started.zh.md

@@ -1,18 +1,18 @@
 # 快速入门
 
-本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得非常简单，可以快速完成。
+本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得简单明了，几分钟内即可完成。
 
-## 前置要求
+## 前提条件
 
 在继续安装之前，请确保您的系统满足以下要求：
 
-*   **Node.js**：需要 20 或更高版本。DocSmith 使用 Node.js 包管理器（npm）进行安装，该管理器包含在 Node.js 的安装包中。要安装 Node.js，请访问 [Node.js 官方网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
+*   **Node.js**：需要 20 或更高版本。DocSmith 使用 Node Package Manager (npm) 进行安装，npm 已包含在 Node.js 的安装包中。要安装 Node.js，请访问官方 [Node.js 网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
 
-*   **API 密钥**：开始时不需要任何 API 密钥。默认情况下，DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成，这使您无需直接配置即可使用各种大型语言模型。
+*   **API 密钥**：开始时无需任何 API 密钥。默认情况下，DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成，这使您无需直接配置即可使用各种大型语言模型。
 
 ## 安装
 
-该工具作为 AIGNE 命令行界面（CLI）的一部分进行分发。
+该工具作为 AIGNE 命令行界面 (CLI) 的一部分进行分发。安装过程包括两个简单的步骤。
 
 ### 第 1 步：安装 AIGNE CLI
 
@@ -22,21 +22,21 @@
 npm install -g @aigne/cli
 ```
 
-该命令会下载并安装软件包，使 `aigne` 命令在任何目录下都可用。
+此命令会从 npm 注册表下载并安装该软件包，使 `aigne` 命令在您终端的任何目录中都可用。
 
 ### 第 2 步：验证安装
 
-安装完成后，通过运行文档工具的帮助命令来验证安装：
+安装完成后，您可以通过运行文档工具的帮助命令来验证安装：
 
 ```bash title="验证安装"
 aigne doc --help
 ```
 
-该命令应显示 DocSmith 的可用命令和选项列表，以确认安装成功。
+此命令应显示可用的 DocSmith 命令及其选项列表，这确认了安装已成功。
 
 ## 生成您的第一份文档
 
-请按照以下步骤分析您的项目并生成一套完整的文档。
+请按照以下步骤分析您的项目并生成一整套文档。
 
 ### 第 1 步：导航到您的项目目录
 
@@ -48,7 +48,7 @@ cd /path/to/your/project
 
 ### 第 2 步：运行生成命令
 
-执行主要的 `generate` 命令。这个单一的命令会处理整个文档创建过程。
+执行主要的 `generate` 命令。这一个命令即可处理从分析到内容生成的整个文档创建过程。
 
 ```bash title="运行生成命令"
 aigne doc generate
@@ -56,17 +56,36 @@ aigne doc generate
 
 ### 第 3 步：完成交互式设置
 
-当您首次在项目中运行 `generate` 命令时，DocSmith 将启动一次性的交互式设置过程。系统会询问您一系列问题，以配置您的文档偏好，例如其主要目的、目标受众和语言。系统将在 `.aigne/doc-smith` 目录中创建一个 `config.yaml` 文件来存储您的设置。
+当您首次在项目中运行 `generate` 命令时，DocSmith 将启动一次性的交互式设置过程。系统将引导您完成一系列问题，以配置您的文档偏好，例如其主要目的、目标受众和语言。
+
+![交互式设置过程的屏幕截图](../assets/screenshots/doc-complete-setup.png)
+
+您的回答将保存到位于 `.aigne/doc-smith` 目录中的 `config.yaml` 文件。如果需要，稍后可以手动编辑此文件。
 
 ### 第 4 步：等待生成
 
 设置完成后，DocSmith 将自动执行以下操作：
 
-1.  **分析代码库**：它会扫描您的源文件以理解项目的结构和逻辑。
-2.  **规划结构**：它会为文档创建一个逻辑计划，包括章节和主题。
-3.  **生成内容**：它会根据分析和您的配置来编写文档内容。
+1.  **分析代码库**：扫描您的源文件以了解项目的结构、功能和逻辑。
+2.  **规划结构**：为文档创建一个逻辑规划，概述各个部分和主题。
+3.  **生成内容**：根据分析和您的配置编写文档内容。
+
+完成后，将出现一条确认消息，生成的文件将位于设置期间指定的输出目录中（默认为 `.aigne/doc-smith/docs`）。
+
+![生成成功后显示成功消息的屏幕截图](../assets/screenshots/doc-generated-successfully.png)
+
+## 探索所有命令
+
+DocSmith 提供了一组命令来管理文档的整个生命周期。下表列出了所有可用命令及其功能。
 
-完成后，将显示一条确认消息，生成的文件将位于设置期间指定的输出目录中（例如 `.aigne/doc-smith/docs`）。
+| 命令 | 描述 |
+| :---------- | :------------------------------------------------------------------------------------------------------------ |
+| `generate` | 分析代码库并根据配置生成一整套文档。 |
+| `update` | 交互式地选择并重新生成现有文档的特定部分，通常会附带新的反馈。 |
+| `translate` | 将现有文档翻译成 12 种支持的语言中的一种或多种，例如 `zh` 或 `ja`。 |
+| `publish` | 将生成的文档发布到实时平台，使其可通过 URL 访问。 |
+| `init` | 启动交互式设置向导以创建或覆盖 `config.yaml` 配置文件。 |
+| `prefs` | 显示 `config.yaml` 文件中的当前配置设置。 |
 
 ## 后续步骤
 
@@ -77,12 +96,12 @@ aigne doc generate
     根据代码更改或新要求，修改或重新生成文档的特定部分。
   </x-card>
   <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    将您的文档翻译成 12 种支持的语言中的任意一种，例如中文、西班牙语或德语。
+    将您的文档翻译成 12 种支持的语言中的任何一种，例如中文、西班牙语或德语。
   </x-card>
   <x-card data-title="发布您的文档" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    将您的文档在线发布，供您的团队或公众使用。
+    将您的文档在线提供给您的团队或公众。
   </x-card>
-  <x-card data-title="审查配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    审查并修改在初始设置期间创建的 config.yaml 文件，以调整您的偏好。
+  <x-card data-title="审阅配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
+    审阅和修改在初始设置期间创建的 config.yaml 文件以调整您的偏好。
   </x-card>
-</x-cards>
+</x-cards>

package/docs/guides-cleaning-up.md

@@ -1,51 +1,52 @@
 # Cleaning Up
 
-The `aigne doc clear` command provides a straightforward method for removing generated files, cached data, and configuration settings. This is useful when you want to reset your documentation project, start from a clean state, or troubleshoot issues related to outdated or corrupted files.
+The `aigne doc clear` command provides a systematic method for removing generated files, cached data, and configuration settings from your project. This is a practical step when you need to reset the documentation workspace, start from a clean state, or resolve issues that may be caused by outdated files.
 
 ## Interactive Cleaning
 
-The simplest way to use the command is to run it without any arguments:
+For controlled and precise cleanup, running the command without any arguments is the recommended procedure.
 
 ```bash
 aigne doc clear
 ```
 
-Executing this command will launch an interactive prompt, allowing you to select precisely which items you want to remove. This is the recommended approach for most use cases as it provides clear descriptions for each option and prevents accidental data loss.
+This action initiates an interactive prompt, which lists all available cleanup options. Each option is presented with a clear description of what it does, allowing you to select the exact items for removal. This interactive method prevents the accidental deletion of important data.
 
-## Cleanup Targets
+## Cleanup Options
 
-The `clear` command can remove several distinct types of data. The following table details each available target, what it does, and the specific files or directories it affects.
+The `clear` command can remove several distinct types of data. The following table provides a detailed breakdown of each available option, its function, and the specific files or directories it affects.
 
-| Target | Description | Files and Directories Affected |
+| Option | Description | Files and Directories Affected |
 | :--- | :--- | :--- |
-| `generatedDocs` | Deletes all generated documents in your output directory, but keeps the documentation structure plan. | The directory specified by `docsDir` in your configuration. |
-| `documentStructure` | Deletes all generated documents and the documentation structure plan, effectively resetting your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
-| `documentConfig` | Deletes the project's configuration file. You will need to run `aigne doc init` again after this. | The `.aigne/doc-smith/config.yaml` file. |
-| `authTokens` | Removes saved authorization tokens for publishing sites. You will be prompted to select which sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
-| `deploymentConfig` | Deletes the `appUrl` from your configuration file. | The `.aigne/doc-smith/config.yaml` file. |
+| `generatedDocs` | Deletes all generated documents located in the output directory. The documentation structure plan is preserved. | The directory specified by `docsDir` in your configuration. |
+| `documentStructure` | Deletes all generated documents and the documentation structure plan. This action resets all documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
+| `documentConfig` | Deletes the project's configuration file. After this action, `aigne doc init` must be run to create a new configuration. | The `.aigne/doc-smith/config.yaml` file. |
+| `authTokens` | Removes saved authorization tokens for publishing sites. You will be prompted to select which site authorizations to clear. | The `~/.aigne/doc-smith-connected.yaml` file located in your home directory. |
+| `deploymentConfig` | Removes only the `appUrl` setting from your configuration file, leaving other settings intact. | The `.aigne/doc-smith/config.yaml` file. |
+| `mediaDescription` | Deletes the cached, AI-generated descriptions for your media files. These will be regenerated during the next documentation build. | The `.aigne/doc-smith/cache/media-description.json` file. |
 
 ## Non-Interactive Cleaning
 
-For automated scripts or users who prefer the command line, you can specify one or more targets to clear directly using the `--targets` flag. This will bypass the interactive prompt.
+For use in automated scripts or for users who prefer direct command-line operations, you can specify one or more cleanup targets using the `--targets` flag. This bypasses the interactive prompt and executes the cleanup immediately.
 
-### Clear a Single Target
+### Clear a Single Option
 
-To clear only the generated documents, use the following command:
+To remove only the generated documents, execute the following command:
 
 ```bash
 aigne doc clear --targets generatedDocs
 ```
 
-### Clear Multiple Targets
+### Clear Multiple Options
 
-You can provide multiple target names to clear several items at once. For example, to remove both the document configuration and the documentation structure, run:
+You can provide a space-separated list of target names to remove several items at once. For instance, to delete both the document configuration and the documentation structure, run the command below:
 
 ```bash
 aigne doc clear --targets documentConfig documentStructure
 ```
 
-After clearing your configuration, you can start fresh by running the setup process again.
+After clearing the configuration, you can begin a new setup process.
 
 ---
 
-For more information on the initial setup, refer to the [Initial Setup](./configuration-initial-setup.md) guide.
+For detailed instructions on creating a new configuration, please refer to the [Initial Setup](./configuration-initial-setup.md) guide.

package/docs/guides-evaluating-documents.md

@@ -1,66 +1,107 @@
 # Evaluating Documents
 
-The `evaluate` command provides a systematic process to assess the quality and alignment of your generated documentation. It analyzes both the overall structure and the content of individual documents against the goals you defined during the initial setup. This process results in a detailed report, helping you identify areas for improvement and ensure the documentation effectively serves its intended purpose and audience.
+The `evaluate` command provides a systematic method to assess the quality and completeness of your generated documentation. It analyzes both the overall document structure and the content of individual files against the criteria defined during project setup. The process concludes by generating a detailed report, which helps identify areas for improvement and ensures the documentation aligns with its intended purpose and audience.
 
-## How It Works
+## The Evaluation Process
 
-The evaluation process operates in two primary stages. First, it assesses the high-level document structure, and second, it analyzes the content of each individual document.
+The evaluation command executes a two-stage analysis to provide a comprehensive assessment of your documentation.
 
-1.  **Structure Evaluation**: The tool examines your documentation's overall organization (like a table of contents). It verifies whether the structure is logical and complete based on the documentation goals, target audience, and content depth you selected.
-2.  **Content Evaluation**: After analyzing the structure, the tool inspects each document's content. It scores the document against several quality dimensions, including readability, coherence, and accuracy. It also checks for the correct implementation of code examples.
+```d2
+direction: down
 
-Upon completion, the tool compiles the findings into a user-friendly HTML report, providing both high-level scores and detailed, actionable feedback.
+start: {
+  label: "Run Command\naignite evaluate"
+  shape: oval
+}
 
-## Running the Evaluation
+structure-eval: {
+  label: "Stage 1: Evaluate\nDocument Structure"
+  shape: rectangle
+}
 
-To initiate the evaluation process, execute the following command in your terminal:
+content-eval: {
+  label: "Stage 2: Evaluate\nDocument Content"
+  shape: rectangle
+}
+
+report-gen: {
+  label: "Generate Report"
+  shape: rectangle
+}
+
+output: {
+  label: "Output HTML &\nJSON Report Files"
+  shape: oval
+}
+
+start -> structure-eval: "Analyzes overall organization"
+structure-eval -> content-eval: "Analyzes each file individually"
+content-eval -> report-gen: "Aggregates all findings"
+report-gen -> output: "Saves report to disk"
+```
+
+1.  **Structure Evaluation**: The tool first examines the documentation's high-level organization, analogous to a table of contents. It verifies whether the structure is logical and complete based on the specified documentation goals, target audience, and content depth.
+2.  **Content Evaluation**: Following the structural analysis, the tool inspects the content of each document. It scores each file against several quality dimensions, including readability, coherence, and factual accuracy. It also validates the correctness and formatting of included code snippets.
+
+The findings from both stages are compiled into an HTML report that presents high-level scores and specific, actionable feedback.
+
+## How to Run an Evaluation
+
+To initiate the evaluation process, execute the `evaluate` command from your project's root directory.
+
+### Execute the Command
+
+Open your terminal and run the following command:
 
 ```bash
 aignite evaluate
 ```
 
-The command will display progress as it analyzes your documentation. Once finished, it will provide a message indicating the location of the generated report files.
+The tool will display its progress as it analyzes the documentation.
+
+### Review the Output
+
+Upon completion, a confirmation message will appear in the terminal, specifying the location of the generated report files.
 
 ```text
 ✔ Generate evaluation report
 Evaluation report generated successfully.
-- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
-- HTML Report: .aigc/evaluate/20231027103000/report.html
+- JSON Report: .aigc/evaluate/20240520114500/integrity-report.json
+- HTML Report: .aigc/evaluate/20240520114500/report.html
 ```
 
-You can open the `report.html` file in your web browser to view the detailed analysis.
+Open the `report.html` file in a web browser to view the detailed analysis.
 
-## Understanding the Report
+## Understanding the Evaluation Report
 
-The evaluation report is organized into two main sections, reflecting the two stages of the analysis process.
+The report is organized into sections that correspond to the stages of the evaluation process, providing a clear breakdown of the analysis.
 
-### Structure Evaluation
+### Structure Evaluation Details
 
-This section provides feedback on the overall architecture of your documentation. It measures how well the generated document hierarchy aligns with your specified configuration.
+This section presents feedback on the overall architecture of your documentation. It measures how effectively the document hierarchy aligns with the project's configuration.
 
 | Dimension | Description |
 | :--- | :--- |
-| **Purpose Coverage** | Assesses if the document structure effectively supports the primary goals you selected (e.g., "Get started quickly"). |
-| **Audience Coverage** | Determines if the structure is appropriate for your defined target audience (e.g., "non-technical users"). |
-| **Depth Coverage** | Checks if the level of detail in the structure matches your selected content depth (e.g., "covers all parameters"). |
+| **Purpose Coverage** | Assesses if the document structure adequately supports the primary goals selected (e.g., "Get started quickly"). |
+| **Audience Coverage** | Determines if the structure is organized in a way that is suitable for the defined target audience (e.g., "non-technical users"). |
+| **Depth Coverage** | Checks if the level of detail implied by the structure matches the selected content depth (e.g., "covers all parameters"). |
 
-### Document Content Evaluation
+### Document Content Evaluation Details
 
-This section provides a document-by-document breakdown of content quality. Each document is scored based on a set of standardized criteria.
+This section provides a file-by-file breakdown of content quality. Each document is scored based on a set of standardized criteria.
 
 | Dimension | Description |
 | :--- | :--- |
-| **Readability** | Measures how easy the text is to read and comprehend. |
+| **Readability** | Measures the ease with which the text can be read and understood. |
 | **Coherence** | Evaluates the logical flow and organization of information within the document. |
 | **Content Quality** | Assesses the accuracy, relevance, and clarity of the information presented. |
-| **Consistency** | Checks for uniform terminology, formatting, and style across the document. |
-| **Purpose Alignment** | Determines how well the content meets the specified documentation goals. |
-| **Audience Alignment** | Assesses if the language and examples are suitable for the target audience. |
-| **Knowledge Level Alignment** | Checks if the content complexity matches the defined reader knowledge level. |
-| **Navigability** | Evaluates the effectiveness of internal links and structural elements that help users find information. |
+| **Consistency** | Checks for uniform terminology, formatting, and style throughout the document. |
+| **Purpose Alignment** | Determines how well the content fulfills the specified documentation goals. |
+| **Audience Alignment** | Assesses if the language, tone, and examples are appropriate for the target audience. |
+| **Knowledge Level Alignment** | Checks if the content's complexity matches the defined reader knowledge level. |
 
 ## Summary
 
-Using the `evaluate` command is a crucial step in maintaining accurate and effective documentation. It provides concrete metrics and specific feedback, allowing you to refine your content methodically. After reviewing the evaluation report, you can proceed to make targeted improvements.
+Using the `evaluate` command is an essential step for maintaining accurate and effective documentation. It provides objective metrics and specific feedback, enabling a methodical approach to refining your content. After reviewing the evaluation report, you can make targeted improvements to enhance documentation quality.
 
-For the next steps on modifying your documents based on this feedback, please see the guide on [Updating Documentation](./guides-updating-documentation.md).
+For guidance on modifying your documents based on this feedback, refer to the [Updating Documentation](./guides-updating-documentation.md) guide.