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

package/docs/getting-started.zh.md

@@ -1,120 +1,88 @@
 # 快速入门
 
-本指南将引导您逐步完成 AIGNE DocSmith 的安装、项目配置，并在几分钟内从源代码生成一套完整的文档。
+本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得非常简单，可以快速完成。
 
-## 第 1 步：先决条件
+## 前置要求
 
-在开始之前，请确保您的系统上已安装 Node.js 20 或更高版本。DocSmith 是一个在 Node.js 环境中运行的命令行工具。我们建议使用 Node.js 自带的 Node Package Manager (npm) 进行安装。
+在继续安装之前，请确保您的系统满足以下要求：
 
-有关详细的安装说明，请参阅 [Node.js 官方网站](https://nodejs.org/)。下面提供了针对常见操作系统的简要指南。
+*   **Node.js**：需要 20 或更高版本。DocSmith 使用 Node.js 包管理器（npm）进行安装，该管理器包含在 Node.js 的安装包中。要安装 Node.js，请访问 [Node.js 官方网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
 
-**Windows**
-1.  从 [Node.js 下载页面](https://nodejs.org/en/download) 下载 Windows 安装程序（`.msi`）。
-2.  运行安装程序，并按照设置向导中的提示进行操作。
+*   **API 密钥**：开始时不需要任何 API 密钥。默认情况下，DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成，这使您无需直接配置即可使用各种大型语言模型。
 
-**macOS**
+## 安装
 
-推荐的安装方法是使用 macOS 的包管理器 [Homebrew](https://brew.sh/)。
+该工具作为 AIGNE 命令行界面（CLI）的一部分进行分发。
 
-```bash Terminal icon=lucide:apple
-# 如果尚未安装 Homebrew，请先安装
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+### 第 1 步：安装 AIGNE CLI
 
-# 安装 Node.js
-brew install node
-```
-
-或者，您也可以直接从 [Node.js 网站](https://nodejs.org/) 下载 macOS 安装程序（`.pkg`）。
-
-**Linux**
+要在您的系统上全局安装 AIGNE CLI，请在终端中执行以下命令：
 
-对于基于 Debian 和 Ubuntu 的发行版，请使用以下命令：
-
-```bash Terminal icon=lucide:laptop
-sudo apt-get update
-sudo apt-get install -y ca-certificates curl gnupg
-curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
-sudo apt-get install -y nodejs
+```bash title="安装 AIGNE CLI" icon=logos:npm-icon
+npm install -g @aigne/cli
 ```
 
-对于 Red Hat、CentOS 和 Fedora，请使用以下命令：
+该命令会下载并安装软件包，使 `aigne` 命令在任何目录下都可用。
 
-```bash Terminal icon=lucide:laptop
-curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
-sudo yum install nodejs
-```
-
-### 验证安装
+### 第 2 步：验证安装
 
-安装完成后，打开您的终端并运行以下命令，以确认 Node.js 和 npm 已正确安装：
+安装完成后，通过运行文档工具的帮助命令来验证安装：
 
-```bash Terminal
-node --version
-npm --version
+```bash title="验证安装"
+aigne doc --help
 ```
 
-## 第 2 步：安装 AIGNE CLI
+该命令应显示 DocSmith 的可用命令和选项列表，以确认安装成功。
 
-DocSmith 工具作为官方 AIGNE 命令行界面（CLI）的一部分进行分发。使用 npm 在您的系统上全局安装 CLI：
+## 生成您的第一份文档
 
-```bash Terminal icon=logos:npm
-npm install -g @aigne/cli
-```
+请按照以下步骤分析您的项目并生成一套完整的文档。
 
-安装完成后，运行其帮助命令来验证 DocSmith 是否可用：
+### 第 1 步：导航到您的项目目录
 
-```bash Terminal
-aigne doc --help
-```
+打开您的终端，使用 `cd` 命令将当前目录更改为您希望记录的项目的根目录。
 
-此命令应显示 DocSmith 的帮助菜单，确认其已安装并准备就绪。
+```bash title="更改目录" icon=mdi:folder-open
+cd /path/to/your/project
+```
 
-## 第 3 步：生成您的文档
+### 第 2 步：运行生成命令
 
-安装 AIGNE CLI 后，您现在可以生成文档了。在您的终端中，导航到项目的根目录并执行以下命令：
+执行主要的 `generate` 命令。这个单一的命令会处理整个文档创建过程。
 
-```bash Terminal icon=lucide:sparkles
+```bash title="运行生成命令"
 aigne doc generate
 ```
 
-![运行 generate 命令会启动该过程并触发智能设置向导。](../assets/screenshots/doc-generate.png)
-
-### 自动配置
-
-当您第一次在新项目中运行此命令时，DocSmith 会检测到不存在配置文件，并会自动启动一个交互式设置向导来引导您完成整个过程。
+### 第 3 步：完成交互式设置
 
-该向导将提出一系列问题来定义您文档的特性，包括：
+当您首次在项目中运行 `generate` 命令时，DocSmith 将启动一次性的交互式设置过程。系统会询问您一系列问题，以配置您的文档偏好，例如其主要目的、目标受众和语言。系统将在 `.aigne/doc-smith` 目录中创建一个 `config.yaml` 文件来存储您的设置。
 
-*   主要目的和写作风格。
-*   预期的目标受众（例如，开发者、最终用户）。
-*   主要语言以及用于翻译的其他语言。
-*   供 AI 分析的源代码路径。
-*   生成文档文件的输出目录。
+### 第 4 步：等待生成
 
-![回答一系列问题以完成项目设置。](../assets/screenshots/doc-complete-setup.png)
+设置完成后，DocSmith 将自动执行以下操作：
 
-在您回答完提示后，DocSmith 会将您的选择保存到配置文件中，开始分析您的代码库，规划文档结构，并生成内容。
+1.  **分析代码库**：它会扫描您的源文件以理解项目的结构和逻辑。
+2.  **规划结构**：它会为文档创建一个逻辑计划，包括章节和主题。
+3.  **生成内容**：它会根据分析和您的配置来编写文档内容。
 
-![DocSmith 将规划文档结构并开始生成文件。](../assets/screenshots/doc-generate-docs.png)
+完成后，将显示一条确认消息，生成的文件将位于设置期间指定的输出目录中（例如 `.aigne/doc-smith/docs`）。
 
-## 第 4 步：查看您的输出
+## 后续步骤
 
-生成过程完成后，您的终端中将显示一条确认消息，表明您的文档已成功创建。您的新文档现在位于您在设置过程中指定的输出目录中。如果您使用了默认设置，可以在 `.aigne/doc-smith/docs` 中找到它。
+您已成功生成第一套文档。以下是管理和增强文档的常见后续步骤：
 
-![一条确认消息表示文档已成功生成。](../assets/screenshots/doc-generated-successfully.png)
-
-## 接下来做什么？
-
-您已成功生成了第一套文档。现在，您可以开始探索更高级的功能和自定义选项。
-
-<x-cards>
-  <x-card data-title="核心功能" data-icon="lucide:box" data-href="/features">
-    探索主要命令和功能，从更新文档到在线发布。
+<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 种支持的语言中的任意一种，例如中文、西班牙语或德语。
   </x-card>
-  <x-card data-title="配置指南" data-icon="lucide:settings" data-href="/configuration">
-    了解如何通过编辑配置文件来微调文档的风格、受众和语言。
+  <x-card data-title="发布您的文档" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
+    将您的文档在线发布，供您的团队或公众使用。
   </x-card>
-  <x-card data-title="CLI 命令参考" data-icon="lucide:terminal" data-href="/cli-reference">
-    获取所有可用的 `aigne doc` 命令及其选项的完整参考。
+  <x-card data-title="审查配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
+    审查并修改在初始设置期间创建的 config.yaml 文件，以调整您的偏好。
   </x-card>
 </x-cards>

package/docs/guides-cleaning-up.ja.md

@@ -0,0 +1,50 @@
+# クリーンアップ
+
+`aigne doc clear` コマンドは、生成されたファイル、キャッシュされたデータ、および設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から始めたり、古いまたは破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
+
+## 対話的なクリーンアップ
+
+このコマンドを使用する最も簡単な方法は、引数なしで実行することです。
+
+```bash
+aigne doc clear
+```
+
+このコマンドを実行すると対話型プロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐため、ほとんどのユースケースでこのアプローチが推奨されます。
+
+## クリーンアップ対象
+
+`clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各対象、その機能、および影響を受ける特定のファイルまたはディレクトリについて詳しく説明しています。
+
+| 対象 | 説明 | 影響を受けるファイルとディレクトリ |
+| :--- | :--- | :--- |
+| **生成されたドキュメント** | ドキュメント出力ディレクトリに生成されたすべての Markdown ファイルを削除します。 | 設定で `docsDir` によって指定されたディレクトリ。 |
+| **ドキュメント構造** | 構造計画ファイルとすべての生成されたドキュメントを削除します。これにより、ドキュメントの内容が効果的にリセットされます。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
+| **ドキュメント設定** | プロジェクトの設定ファイルを削除します。これを実行した後、プロジェクトを再初期化する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
+| **認証情報** | ドキュメントを公開するために使用される保存済みの認証トークンを削除します。クリアする特定のサイトを選択するように求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
+
+## 非対話的なクリーンアップ
+
+自動化スクリプトやコマンドラインを好むユーザー向けに、`--targets` フラグを使用してクリアする対象を1つ以上直接指定できます。これにより、対話型プロンプトがバイパスされます。
+
+### 単一の対象をクリア
+
+生成されたドキュメントのみをクリアするには、次のコマンドを使用します。
+
+```bash
+aigne doc clear --targets generatedDocs
+```
+
+### 複数の対象をクリア
+
+複数の対象名を指定して、一度にいくつかの項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します。
+
+```bash
+aigne doc clear --targets documentConfig documentStructure
+```
+
+設定をクリアした後、セットアッププロセスを再度実行して、新たに始めることができます。
+
+---
+
+初期設定に関する詳細については、[初期設定](./configuration-initial-setup.md) ガイドを参照してください。

package/docs/guides-cleaning-up.md

@@ -0,0 +1,50 @@
+# 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.
+
+## Interactive Cleaning
+
+The simplest way to use the command is to run it without any arguments:
+
+```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.
+
+## Cleanup Targets
+
+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.
+
+| Target | Description | Files and Directories Affected |
+| :--- | :--- | :--- |
+| **Generated Documents** | Deletes all Markdown files that were generated in your documentation output directory. | The directory specified by `docsDir` in your configuration. |
+| **Documentation Structure** | Deletes the structure plan file and all generated documents. This effectively resets your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
+| **Document Configuration** | Deletes the project's configuration file. After running this, you will need to re-initialize the project. | The `.aigne/doc-smith/config.yaml` file. |
+| **Authorizations** | Removes saved authorization tokens used for publishing your documentation. You will be prompted to select specific sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
+
+## 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.
+
+### Clear a Single Target
+
+To clear only the generated documents, use the following command:
+
+```bash
+aigne doc clear --targets generatedDocs
+```
+
+### Clear Multiple Targets
+
+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:
+
+```bash
+aigne doc clear --targets documentConfig documentStructure
+```
+
+After clearing your configuration, you can start fresh by running the setup process again.
+
+---
+
+For more information on the initial setup, refer to the [Initial Setup](./configuration-initial-setup.md) guide.

package/docs/guides-cleaning-up.zh-TW.md

@@ -0,0 +1,50 @@
+# 清理
+
+`aigne doc clear` 指令提供了一種直接的方法，用於移除生成的檔案、快取資料和配置設定。當您想重設文件專案、從乾淨的狀態開始，或解決與過時或損壞檔案相關的問題時，此功能非常有用。
+
+## 互動式清理
+
+使用此指令最簡單的方法就是不帶任何參數直接執行：
+
+```bash
+aigne doc clear
+```
+
+執行此指令將會啟動一個互動式提示，讓您能精確選擇要移除的項目。對於大多數使用情境而言，這是建議的方法，因為它為每個選項提供了清晰的說明，並能防止意外的資料遺失。
+
+## 清理目標
+
+`clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能，以及它所影響的特定檔案或目錄。
+
+| 目標 | 說明 | 受影響的檔案和目錄 |
+| :--- | :--- | :--- |
+| **生成的檔案** | 刪除在您的文件輸出目錄中生成的所有 Markdown 檔案。 | 您的配置中由 `docsDir` 指定的目錄。 |
+| **文件結構** | 刪除結構計畫檔案和所有生成的檔案。這能有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
+| **文件配置** | 刪除專案的設定檔。執行此操作後，您將需要重新初始化專案。 | `.aigne/doc-smith/config.yaml` 檔案。 |
+| **授權** | 移除用於發布文件的已儲存授權權杖。系統將提示您選擇要清除授權的特定網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
+
+## 非互動式清理
+
+對於自動化腳本或偏好使用命令列的使用者，您可以使用 `--targets` 旗標直接指定一個或多個要清理的目標。這將會繞過互動式提示。
+
+### 清理單一目標
+
+若要僅清理生成的檔案，請使用以下指令：
+
+```bash
+aigne doc clear --targets generatedDocs
+```
+
+### 清理多個目標
+
+您可以提供多個目標名稱來一次性清理多個項目。例如，若要同時移除文件配置和文件結構，請執行：
+
+```bash
+aigne doc clear --targets documentConfig documentStructure
+```
+
+清理完配置後，您可以再次執行設定流程以重新開始。
+
+---
+
+有關初始設定的更多資訊，請參閱 [初始設定](./configuration-initial-setup.md) 指南。

package/docs/guides-cleaning-up.zh.md

@@ -0,0 +1,50 @@
+# 清理
+
+`aigne doc clear` 命令提供了一种直接的方法，用于移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从一个干净的状态开始，或者排查与过时或损坏文件相关的问题时，这个命令非常有用。
+
+## 交互式清理
+
+使用该命令最简单的方法是不带任何参数运行它：
+
+```bash
+aigne doc clear
+```
+
+执行此命令将启动一个交互式提示，让您精确选择要移除的项目。这是大多数用例的推荐方法，因为它为每个选项提供了清晰的描述，并能防止意外的数据丢失。
+
+## 清理目标
+
+`clear` 命令可以移除几种不同类型的数据。下表详细介绍了每个可用目标、其功能以及它影响的具体文件或目录。
+
+| 目标 | 描述 | 受影响的文件和目录 |
+| :--- | :--- | :--- |
+| **生成的文档** | 删除在您的文档输出目录中生成的所有 Markdown 文件。 | 您的配置中由 `docsDir` 指定的目录。 |
+| **文档结构** | 删除结构计划文件和所有生成的文档。这将有效地重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
+| **文档配置** | 删除项目的配置文件。运行此操作后，您需要重新初始化项目。 | `.aigne/doc-smith/config.yaml` 文件。 |
+| **授权** | 移除用于发布文档的已保存授权令牌。系统将提示您选择要清除授权的特定站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
+
+## 非交互式清理
+
+对于自动化脚本或偏好命令行的用户，您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
+
+### 清理单个目标
+
+要仅清理生成的文档，请使用以下命令：
+
+```bash
+aigne doc clear --targets generatedDocs
+```
+
+### 清理多个目标
+
+您可以提供多个目标名称以一次性清理多个项目。例如，要同时移除文档配置和文档结构，请运行：
+
+```bash
+aigne doc clear --targets documentConfig documentStructure
+```
+
+清理配置后，您可以再次运行设置过程以重新开始。
+
+---
+
+有关初始设置的更多信息，请参阅[初始设置](./configuration-initial-setup.md)指南。

package/docs/guides-evaluating-documents.ja.md

@@ -0,0 +1,66 @@
+# ドキュメントの評価
+
+`evaluate` コマンドは、生成されたドキュメントの品質と整合性を評価するための体系的なプロセスを提供します。初期設定で定義した目標に対して、ドキュメント全体の構造と個々のドキュメントの内容の両方を分析します。このプロセスにより詳細なレポートが生成され、改善点を特定し、ドキュメントが意図した目的と対象読者に効果的に役立つことを確認するのに役立ちます。
+
+## 仕組み
+
+評価プロセスは、主に2つの段階で動作します。まず、高レベルのドキュメント構造を評価し、次に、個々のドキュメントの内容を分析します。
+
+1.  **構造評価**: このツールは、ドキュメント全体の構成（目次など）を検査します。選択したドキュメントの目標、対象読者、および内容の深さに基づいて、構造が論理的で完全であるかどうかを検証します。
+2.  **内容評価**: 構造を分析した後、ツールは各ドキュメントの内容を検査します。読みやすさ、一貫性、正確性など、いくつかの品質次元に対してドキュメントをスコアリングします。また、コード例が正しく実装されているかもチェックします。
+
+完了すると、ツールは結果をユーザーフレンドリーなHTMLレポートにまとめ、高レベルのスコアと詳細で実行可能なフィードバックの両方を提供します。
+
+## 評価の実行
+
+評価プロセスを開始するには、ターミナルで次のコマンドを実行します。
+
+```bash
+aignite evaluate
+```
+
+コマンドは、ドキュメントを分析する際の進捗状況を表示します。完了すると、生成されたレポートファイルの場所を示すメッセージが表示されます。
+
+```text
+✔ Generate evaluation report
+Evaluation report generated successfully.
+- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
+- HTML Report: .aigc/evaluate/20231027103000/report.html
+```
+
+Webブラウザで `report.html` ファイルを開くと、詳細な分析を表示できます。
+
+## レポートの理解
+
+評価レポートは、分析プロセスの2つの段階を反映して、2つの主要なセクションに分かれています。
+
+### 構造評価
+
+このセクションでは、ドキュメント全体のアーキテクチャに関するフィードバックを提供します。生成されたドキュメント階層が、指定した設定とどれだけ整合しているかを測定します。
+
+| ディメンション | 説明 |
+| :--- | :--- |
+| **目的カバレッジ** | ドキュメント構造が、選択した主要な目標（例：「すぐに始める」）を効果的にサポートしているかを評価します。 |
+| **対象読者カバレッジ** | 構造が、定義した対象読者（例：「非技術系ユーザー」）に対して適切であるかを判断します。 |
+| **深度カバレッジ** | 構造の詳細レベルが、選択した内容の深さ（例：「すべてのパラメータをカバー」）と一致しているかを確認します。 |
+
+### ドキュメント内容の評価
+
+このセクションでは、内容の品質をドキュメントごとに分析します。各ドキュメントは、一連の標準化された基準に基づいてスコアリングされます。
+
+| ディメンション | 説明 |
+| :--- | :--- |
+| **読みやすさ** | テキストがどれだけ読みやすく、理解しやすいかを測定します。 |
+| **整合性** | ドキュメント内の情報の論理的な流れと構成を評価します。 |
+| **内容の品質** | 提示された情報の正確性、関連性、明確さを評価します。 |
+| **統一性** | ドキュメント全体で用語、フォーマット、スタイルが統一されているかを確認します。 |
+| **目的との整合性** | 内容が指定されたドキュメントの目標をどれだけ満たしているかを判断します。 |
+| **対象読者との整合性** | 言語と例が対象読者に適しているかを評価します。 |
+| **知識レベルとの整合性** | 内容の複雑さが、定義された読者の知識レベルと一致しているかを確認します。 |
+| **ナビゲーション性** | ユーザーが情報を見つけるのに役立つ内部リンクや構造要素の有効性を評価します。 |
+
+## まとめ
+
+`evaluate` コマンドの使用は、正確で効果的なドキュメントを維持するための重要なステップです。具体的な指標と特定のフィードバックを提供し、内容を体系的に改善することができます。評価レポートを確認した後、的を絞った改善を進めることができます。
+
+このフィードバックに基づいてドキュメントを修正する次のステップについては、[ドキュメントの更新](./guides-updating-documentation.md)のガイドを参照してください。

package/docs/guides-evaluating-documents.md

@@ -0,0 +1,66 @@
+# 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.
+
+## How It Works
+
+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.
+
+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.
+
+Upon completion, the tool compiles the findings into a user-friendly HTML report, providing both high-level scores and detailed, actionable feedback.
+
+## Running the Evaluation
+
+To initiate the evaluation process, execute the following command in your terminal:
+
+```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.
+
+```text
+✔ Generate evaluation report
+Evaluation report generated successfully.
+- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
+- HTML Report: .aigc/evaluate/20231027103000/report.html
+```
+
+You can open the `report.html` file in your web browser to view the detailed analysis.
+
+## Understanding the Report
+
+The evaluation report is organized into two main sections, reflecting the two stages of the analysis process.
+
+### Structure Evaluation
+
+This section provides feedback on the overall architecture of your documentation. It measures how well the generated document hierarchy aligns with your specified 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"). |
+
+### Document Content Evaluation
+
+This section provides a document-by-document 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. |
+| **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. |
+
+## 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.
+
+For the next steps on modifying your documents based on this feedback, please see the guide on [Updating Documentation](./guides-updating-documentation.md).

package/docs/guides-evaluating-documents.zh-TW.md

@@ -0,0 +1,66 @@
+# 評估文件
+
+`evaluate` 指令提供了一個系統化的流程，用以評估您所產生的文件的品質與契合度。它會根據您在初始設定中定義的目標，分析整體結構以及個別文件的內容。此流程會產出一份詳細的報告，幫助您找出需要改進的地方，並確保文件能有效地服務其預期目的和讀者。
+
+## 運作方式
+
+評估流程主要分為兩個階段。首先，它會評估高層次的文件結構；其次，它會分析每份個別文件的內容。
+
+1.  **結構評估**：該工具會檢查您文件的整體組織（例如目錄）。它會根據您所選的文件目標、目標讀者和內容深度，驗證結構是否合乎邏輯且完整。
+2.  **內容評估**：分析完結構後，該工具會檢視每份文件的內容。它會根據多個品質維度（包括可讀性、連貫性和準確性）對文件進行評分。它還會檢查程式碼範例的實作是否正確。
+
+完成後，該工具會將結果彙編成一份易於使用的 HTML 報告，提供高層次的分數和詳細、可行的回饋。
+
+## 執行評估
+
+要啟動評估流程，請在您的終端機中執行以下指令：
+
+```bash
+aignite evaluate
+```
+
+該指令在分析您的文件時會顯示進度。完成後，它會提供一則訊息，指出所產生的報告檔案的位置。
+
+```text
+✔ Generate evaluation report
+Evaluation report generated successfully.
+- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
+- HTML Report: .aigc/evaluate/20231027103000/report.html
+```
+
+您可以在網頁瀏覽器中開啟 `report.html` 檔案，以查看詳細的分析。
+
+## 理解報告
+
+評估報告分為兩個主要部分，對應分析流程的兩個階段。
+
+### 結構評估
+
+此部分提供關於您文件整體架構的回饋。它衡量所產生的文件層級結構與您指定的設定的契合程度。
+
+| 維度 | 說明 |
+| :--- | :--- |
+| **目的涵蓋率** | 評估文件結構是否有效地支援您所選的主要目標（例如，「快速入門」）。 |
+| **讀者涵蓋率** | 判斷結構是否適合您所定義的目標讀者（例如，「非技術使用者」）。 |
+| **深度涵蓋率** | 檢查結構中的細節層級是否與您所選的內容深度相符（例如，「涵蓋所有參數」）。 |
+
+### 文件內容評估
+
+此部分逐一分析各文件的內容品質。每份文件都會根據一組標準化準則進行評分。
+
+| 維度 | 說明 |
+| :--- | :--- |
+| **可讀性** | 衡量文字閱讀和理解的難易程度。 |
+| **連貫性** | 評估文件內資訊的邏輯流程與組織。 |
+| **內容品質** | 評估所呈現資訊的準確性、相關性和清晰度。 |
+| **一致性** | 檢查整份文件中的術語、格式和風格是否統一。 |
+| **目的契合度** | 判斷內容與指定文件目標的契合程度。 |
+| **讀者契合度** | 評估語言和範例是否適合目標讀者。 |
+| **知識水準契合度** | 檢查內容的複雜度是否與所定義的讀者知識水準相符。 |
+| **導覽性** | 評估內部連結和結構元素在幫助使用者尋找資訊方面的有效性。 |
+
+## 總結
+
+使用 `evaluate` 指令是維護準確且有效文件的關鍵步驟。它提供具體的指標和明確的回饋，讓您能有條不紊地完善您的內容。檢視評估報告後，您便可以著手進行針對性的改進。
+
+關於根據此回饋修改文件的後續步驟，請參閱 [更新文件](./guides-updating-documentation.md) 的指南。

package/docs/guides-evaluating-documents.zh.md

@@ -0,0 +1,66 @@
+# 评估文档
+
+`evaluate` 命令提供了一个系统化的流程，用于评估您生成的文档的质量和一致性。它会根据您在初始设置中定义的目标，分析文档的整体结构和单个文档的内容。此过程会生成一份详细的报告，帮助您识别需要改进的地方，并确保文档能够有效地服务于其预定目的和受众。
+
+## 工作原理
+
+评估过程分为两个主要阶段。首先，它评估高层级的文档结构；其次，它分析每个独立文档的内容。
+
+1.  **结构评估**：该工具会检查您文档的整体组织结构（例如目录）。它会根据您选择的文档目标、目标受众和内容深度，验证结构是否逻辑清晰且完整。
+2.  **内容评估**：在分析结构之后，该工具会检查每个文档的内容。它会根据可读性、连贯性和准确性等多个质量维度对文档进行评分。它还会检查代码示例的正确实现。
+
+完成后，该工具会将结果汇编成一份用户友好的 HTML 报告，提供高层级评分和详细、可操作的反馈。
+
+## 运行评估
+
+要启动评估过程，请在终端中执行以下命令：
+
+```bash
+aignite evaluate
+```
+
+该命令在分析您的文档时会显示进度。完成后，它将提供一条消息，指明生成的报告文件的位置。
+
+```text
+✔ Generate evaluation report
+Evaluation report generated successfully.
+- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
+- HTML Report: .aigc/evaluate/20231027103000/report.html
+```
+
+您可以在 Web 浏览器中打开 `report.html` 文件以查看详细分析。
+
+## 理解报告
+
+评估报告分为两个主要部分，对应分析过程的两个阶段。
+
+### 结构评估
+
+本节提供关于您文档整体架构的反馈。它衡量了生成的文档层次结构与您指定配置的对齐程度。
+
+| 维度 | 描述 |
+| :--- | :--- |
+| **目的覆盖率** | 评估文档结构是否有效支持您选择的主要目标（例如，“快速入门”）。 |
+| **受众覆盖率** | 判断结构是否适合您定义的目标受众（例如，“非技术用户”）。 |
+| **深度覆盖率** | 检查结构中的细节层次是否与您选择的内容深度相匹配（例如，“涵盖所有参数”）。 |
+
+### 文档内容评估
+
+本节按文档逐一分解内容质量。每个文档都根据一组标准化标准进行评分。
+
+| 维度 | 描述 |
+| :--- | :--- |
+| **可读性** | 衡量文本阅读和理解的难易程度。 |
+| **连贯性** | 评估文档内信息的逻辑流程和组织。 |
+| **内容质量** | 评估所呈现信息的准确性、相关性和清晰度。 |
+| **一致性** | 检查整个文档中术语、格式和风格的统一性。 |
+| **目的对齐** | 判断内容与指定的文档目标的契合程度。 |
+| **受众对齐** | 评估语言和示例是否适合目标受众。 |
+| **知识水平对齐** | 检查内容复杂度是否与定义的读者知识水平相匹配。 |
+| **导航性** | 评估内部链接和结构元素在帮助用户查找信息方面的有效性。 |
+
+## 总结
+
+使用 `evaluate` 命令是维护准确有效文档的关键步骤。它提供具体的指标和明确的反馈，让您能够有条不紊地优化内容。在审阅评估报告后，您可以着手进行有针对性的改进。
+
+关于根据此反馈修改文档的后续步骤，请参阅[更新文档](./guides-updating-documentation.md)指南。