@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7

package/agents/update/user-review-document.mjs

@@ -134,7 +134,8 @@ export default async function userReviewDocument(
   // Print current document headings structure
   printDocumentHeadings(content, title || "Untitled Document");
 
-  let currentContent = content;
+  // Initialize shared context with current content
+  options.context.userContext.currentContent = content;
 
   const MAX_ITERATIONS = 100;
   let iterationCount = 0;
@@ -163,7 +164,10 @@ export default async function userReviewDocument(
     if (action === "finish") {
       break;
     } else if (action === "view") {
-      await showDocumentDetail(currentContent, title || "Untitled Document");
+      await showDocumentDetail(
+        options.context.userContext.currentContent,
+        title || "Untitled Document",
+      );
     }
 
     // Ask for feedback
@@ -200,20 +204,13 @@ export default async function userReviewDocument(
 
     try {
       // Call updateDocument agent with feedback
-      const result = await options.context.invoke(updateAgent, {
+      await options.context.invoke(updateAgent, {
         ...rest,
-        originalContent: currentContent,
+        originalContent: options.context.userContext.currentContent,
         feedback: feedback.trim(),
         userPreferences,
       });
 
-      if (result.updatedContent) {
-        currentContent = result.updatedContent;
-        console.log(`\n✅ ${result.operationSummary || "Document updated successfully"}\n`);
-      } else {
-        console.log("\n❌ We couldn't update the document. Please try rephrasing your feedback.\n");
-      }
-
       // Check if feedback should be saved as user preference
       const feedbackRefinerAgent = options.context.agents["checkFeedbackRefiner"];
       if (feedbackRefinerAgent) {
@@ -229,7 +226,10 @@ export default async function userReviewDocument(
       }
 
       // Print updated document headings structure
-      printDocumentHeadings(currentContent, title || "Untitled Document");
+      printDocumentHeadings(
+        options.context.userContext.currentContent,
+        title || "Untitled Document",
+      );
     } catch (error) {
       console.error("Error processing your feedback:");
       console.error(`Type: ${error.name}`);
@@ -242,7 +242,7 @@ export default async function userReviewDocument(
     }
   }
 
-  return { content: currentContent };
+  return { content: options.context.userContext.currentContent };
 }
 
 userReviewDocument.taskTitle = "User review and modify document content";

package/agents/utils/check-feedback-refiner.mjs

@@ -62,7 +62,7 @@ checkFeedbackRefiner.input_schema = {
     },
     documentStructureFeedback: {
       type: "string",
-      description: "Feedback from document structure stage",
+      description: "Feedback from documentation structure stage",
     },
     stage: {
       type: "string",

package/agents/utils/choose-docs.mjs

@@ -41,7 +41,7 @@ export default async function chooseDocs(
 
       // Convert files to choices with titles
       const choices = mainLanguageFiles.map((file) => {
-        // Convert filename to flat path to find corresponding document structure item
+        // Convert filename to flat path to find corresponding documentation structure item
         const flatName = file.replace(/\.md$/, "").replace(/\.\w+(-\w+)?$/, "");
         const docItem = documentExecutionStructure.find((item) => {
           const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");

package/agents/utils/load-document-all-content.mjs

@@ -4,19 +4,19 @@ import { findItemByPath, readFileContent } from "../../utils/docs-finder-utils.m
 /**
  * Loads a document's content along with all its translations from the docs directory.
  *
- * This function finds a document by its path in the document structure, then searches
+ * This function finds a document by its path in the documentation structure, then searches
  * for all translation files in the docs directory that match the document's naming pattern.
  * Translation files are identified by the pattern: {flatName}.{language-code}.md
  *
  * @param {Object} params - The parameters object
  * @param {string} params.path - The document path to find in the structure
  * @param {string} params.docsDir - The directory containing document files and translations
- * @param {Object} params.documentStructure - The document structure object to search in
+ * @param {Object} params.documentStructure - The documentation structure object to search in
  * @returns {Promise<Object>} An object containing the document data with translations
  * @throws {Error} Throws an error if the document path is not found in the structure
  */
 export default async function loadDocumentAllContent({ path, docsDir, documentStructure }) {
-  // Find the document item by path in the document structure
+  // Find the document item by path in the documentation structure
   const result = await findItemByPath(documentStructure, path, null, docsDir);
 
   if (!result) {

package/agents/utils/load-sources.mjs

@@ -175,7 +175,7 @@ export default async function loadSources({
     }),
   );
 
-  // Get the last document structure
+  // Get the last documentation structure
   let originalDocumentStructure;
   if (outputDir) {
     const documentStructurePath = path.join(outputDir, "structure-plan.json");

package/agents/utils/save-docs.mjs

@@ -35,39 +35,18 @@ export default async function saveDocs({
     console.error("Failed to save _sidebar.md:", err.message);
   }
 
-  // Clean up invalid .md files that are no longer in the document structure
+  // Clean up invalid .md files that are no longer in the documentation structure
   try {
     await cleanupInvalidFiles(documentStructure, docsDir, translateLanguages, locale);
   } catch (err) {
     console.error("Failed to cleanup invalid .md files:", err.message);
   }
 
-  const message = `# ✅ Documentation Generated Successfully!
-
-Generated **${documentStructure.length}** documents and saved to: \`${docsDir}\`
+  const message = `
+✅ Documentation generated successfully! (\`${documentStructure.length}\` documents → \`${docsDir}\`)
 ${projectInfoMessage || ""}
-## 🚀 Next Steps
-
-**Publish Your Documentation**
-
-Generate a shareable preview link for your team:
-
-  \`aigne doc publish\`
-
-## 🔧 Optional Actions
-
-**Update Specific Documents**
-
-Regenerate content for individual documents:
-
-  \`aigne doc update\`
-
-**Refine Document Structure**
-
-Review and improve your documentation organization:
-
-  \`aigne doc generate\`
-
+🚀 Next: Make your documentation live and generate a shareable link, run: \`aigne doc publish\`
+💡 Optional: Update specific document (\`aigne doc update\`) or refine documentation structure (\`aigne doc generate\`)
   `;
 
   // Shutdown mermaid worker pool to ensure clean exit
@@ -94,7 +73,7 @@ function generateFileName(flatName, language) {
 }
 
 /**
- * Clean up .md files that are no longer in the document structure
+ * Clean up .md files that are no longer in the documentation structure
  * @param {Array<{path: string, title: string}>} documentStructure
  * @param {string} docsDir
  * @param {Array<string>} translateLanguages
@@ -109,7 +88,7 @@ async function cleanupInvalidFiles(documentStructure, docsDir, translateLanguage
     const files = await readdir(docsDir);
     const mdFiles = files.filter((file) => file.endsWith(".md"));
 
-    // Generate expected file names from document structure
+    // Generate expected file names from documentation structure
     const expectedFiles = new Set();
 
     // Add main document files

package/aigne.yaml

@@ -9,7 +9,7 @@ agents:
   # Initialization
   - ./agents/init/index.mjs
 
-  # Document Structure Generation
+  # Documentation Structure Generation
   - ./agents/generate/generate-structure.yaml
   - ./agents/generate/update-document-structure.yaml
   - ./agents/generate/check-need-generate-structure.mjs
@@ -18,7 +18,7 @@ agents:
   - ./agents/generate/user-review-document-structure.mjs
   - ./agents/generate/index.yaml
   
-  # Document Structure Tools
+  # Documentation Structure Tools
   - ./agents/generate/document-structure-tools/add-document.mjs
   - ./agents/generate/document-structure-tools/delete-document.mjs
   - ./agents/generate/document-structure-tools/update-document.mjs

package/docs/_sidebar.md

@@ -14,4 +14,4 @@
 * [Advanced Topics](/advanced.md)
   * [How It Works](/advanced-how-it-works.md)
   * [Quality Assurance](/advanced-quality-assurance.md)
-* [Changelog](/changelog.md)
+* [Changelog](/changelog.md)

package/docs/advanced-how-it-works.ja.md

@@ -1,63 +1,63 @@
 # 仕組み
 
-AIGNE DocSmithは、AIGNEフレームワーク内に構築されたマルチAgentシステムで動作します。単一のモノリシックなプロセスではなく、専門的なAI Agentのパイプラインを編成し、各Agentが特定のタスクを担当します。このアプローチにより、ソースコードを完全なドキュメンテーションに変換するための、構造化されたモジュラーなプロセスが可能になります。
+AIGNE DocSmithは、マルチagentシステムで動作します。単一のモノリシックなプロセスではなく、専門のAI agentのパイプラインを編成し、各agentが特定のタスクを担当します。このアプローチにより、ソースコードを完全なドキュメントに変換するための構造化されたモジュラーなプロセスが可能になります。
 
-このツールは、AIアプリケーションの開発とデプロイのためのプラットフォームを提供する、より大きなAIGNEエコシステムの不可欠な部分です。
+このツールは、AIアプリケーションを開発・展開するためのプラットフォームを提供する、より大きなAIGNEエコシステムの不可欠な部分です。
 
 ![AIGNEエコシステムのアーキテクチャ](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
-## ドキュメンテーション生成パイプライン
+## ドキュメント生成パイプライン
 
-DocSmithの中核は、ソースコードをいくつかの異なるステージを通じて処理するパイプラインです。各ステージは、1つ以上の専用Agentによって管理されます。通常 `aigne doc generate` コマンドによって開始される主要なワークフローは、次のように視覚化できます。
+DocSmithの中核は、ソースコードをいくつかの異なるステージを通して処理するパイプラインです。各ステージは1つ以上の専用agentによって管理されます。通常、`aigne doc generate`コマンドによって開始される主要なワークフローは、次のように視覚化できます。
 
 ```d2
 direction: down
 
 Input: {
-  label: "Source Code & Config"
+  label: "ソースコードと設定"
   shape: rectangle
 }
 
 Pipeline: {
-  label: "Core Generation Pipeline"
+  label: "コア生成パイプライン"
   shape: rectangle
   grid-columns: 1
   grid-gap: 40
 
   Structure-Planning: {
-    label: "1. Structure Planning"
+    label: "1. 構造計画"
     shape: rectangle
   }
 
   Content-Generation: {
-    label: "2. Content Generation"
+    label: "2. コンテンツ生成"
     shape: rectangle
   }
 
   Saving: {
-    label: "3. Save Documents"
+    label: "3. ドキュメント保存"
     shape: rectangle
   }
 }
 
 User-Feedback: {
-  label: "User Feedback Loop\n(via --feedback flag)"
+  label: "ユーザーフィードバックループ\n(--feedbackフラグ経由)"
   shape: rectangle
 }
 
 Optional-Steps: {
-  label: "Optional Post-Generation Steps"
+  label: "オプションの生成後ステップ"
   shape: rectangle
   grid-columns: 2
   grid-gap: 40
   
   Translation: {
-    label: "Translate\n(aigne doc translate)"
+    label: "翻訳\n(aigne doc translate)"
     shape: rectangle
   }
 
   Publishing: {
-    label: "Publish\n(aigne doc publish)"
+    label: "公開\n(aigne doc publish)"
     shape: rectangle
   }
 }
@@ -67,35 +67,35 @@ Pipeline.Structure-Planning -> Pipeline.Content-Generation
 Pipeline.Content-Generation -> Pipeline.Saving
 Pipeline.Saving -> Optional-Steps
 
-User-Feedback -> Pipeline.Structure-Planning: "Refine Structure"
-User-Feedback -> Pipeline.Content-Generation: "Regenerate Content"
+User-Feedback -> Pipeline.Structure-Planning: "構造の改良"
+User-Feedback -> Pipeline.Content-Generation: "コンテンツの再生成"
 ```
 
-1.  **入力分析**: Agentがソースコードとプロジェクト設定（`aigne.yaml`）を読み込むと、プロセスが開始されます。
+1.  **入力分析**: このプロセスは、agentがソースコードとプロジェクト設定（`aigne.yaml`）を読み込むことから始まります。
 
-2.  **構造計画**: Agentがコードベースを分析し、論理的なドキュメント構造を提案します。プロジェクトの構成と指定されたルールに基づいてアウトラインを作成します。
+2.  **構造計画**: あるagentがコードベースを分析し、論理的なドキュメント構造を提案します。プロジェクトの構成と指定されたルールに基づいてアウトラインを作成します。
 
-3.  **コンテンツ生成**: 構造が確定すると、コンテンツ生成Agentがドキュメント計画の各セクションに詳細なテキスト、コード例、説明を埋め込みます。
+3.  **コンテンツ生成**: 構造が決定されると、コンテンツ生成agentがドキュメントプランの各セクションに詳細なテキスト、コード例、説明を埋め込んでいきます。
 
-4.  **改良と更新**: `aigne doc update` または `aigne doc generate --feedback` を介して入力を提供すると、特定のAgentがアクティブになり、個々のドキュメントを更新したり、全体的な構造を調整したりします。
+4.  **改良と更新**: `aigne doc update`または`aigne doc generate --feedback`を介して入力が提供されると、特定のagentがアクティブになり、個々のドキュメントを更新したり、全体の構造を調整したりします。
 
-5.  **翻訳と公開**: 主要なコンテンツが生成された後、オプションのAgentが多言語翻訳や最終的なドキュメンテーションをウェブプラットフォームに公開するなどのタスクを処理します。
+5.  **翻訳と公開**: 主要なコンテンツが生成された後、オプションのagentが多言語翻訳や最終的なドキュメントをウェブプラットフォームに公開するなどのタスクを処理します。
 
 ## 主要なAI Agent
 
-DocSmithの機能は、プロジェクトの設定で定義されたAgentのコレクションによって提供されます。各Agentには特定の役割があります。以下の表は、主要なAgentとその機能の一部をリストアップしたものです。
+DocSmithの機能は、プロジェクトの設定で定義されたagentのコレクションによって提供されます。各agentには特定の役割があります。以下の表は、主要なagentとその機能の一部をリストアップしたものです。
 
-| 機能的役割               | 主要なAgentファイル                                  | 説明                                                                         |
-| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| **構造計画**             | `generate/generate-structure.yaml`                   | ソースコードを分析し、初期のドキュメントアウトラインを提案します。                         |
-| **構造の改良**           | `generate/refine-document-structure.yaml`            | ユーザーのフィードバックに基づいてドキュメント構造を修正します。                             |
-| **コンテンツ生成**         | `update/batch-generate-document.yaml`, `generate-document.yaml` | 各セクションの詳細なコンテンツでドキュメント構造を埋めます。                                 |
-| **翻訳**                 | `translate/translate-document.yaml`, `translate-multilingual.yaml` | 生成されたドキュメンテーションを複数のターゲット言語に翻訳します。                           |
-| **公開**                 | `publish/publish-docs.mjs`                           | Discuss Kitインスタンスへのドキュメント公開プロセスを管理します。                           |
-| **データI/O**              | `utils/load-sources.mjs`, `utils/save-docs.mjs`      | ソースファイルの読み取りと最終的なマークダウンドキュメントのディスクへの書き込みを担当します。 |
+| 機能的役割 | 主要なAgentファイル | 説明 |
+| :--- | :--- | :--- |
+| **構造計画** | `generate/generate-structure.yaml` | ソースコードを分析し、最初のドキュメントアウトラインを提案します。 |
+| **構造の改良** | `generate/refine-document-structure.yaml` | ユーザーのフィードバックに基づいてドキュメントの構造を修正します。 |
+| **コンテンツ生成** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | ドキュメント構造の各セクションに詳細なコンテンツを埋め込みます。 |
+| **翻訳** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | 生成されたドキュメントを複数のターゲット言語に翻訳します。 |
+| **公開** | `publish/publish-docs.mjs` | ドキュメントをDiscuss Kitインスタンスに公開するプロセスを管理します。 |
+| **データI/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | ソースファイルの読み込みと、最終的なマークダウンドキュメントのディスクへの書き込みを担当します。 |
 
-このAgentベースのアーキテクチャにより、ドキュメンテーションプロセスの各ステップを専門ツールで処理でき、構造化され保守可能なワークフローが保証されます。
+このagentベースのアーキテクチャにより、ドキュメント化プロセスの各ステップを専門のツールで処理できるため、構造化され、保守可能なワークフローが保証されます。
 
 ---
 
-DocSmithが出力の正確性とフォーマットを保証するために講じる対策を理解するには、[品質保証](./advanced-quality-assurance.md)のセクションに進んでください。
+DocSmithが出力の正確性と形式を保証するために講じている対策を理解するには、[品質保証](./advanced-quality-assurance.md)のセクションに進んでください。

package/docs/advanced-how-it-works.md

@@ -1,6 +1,6 @@
 # How It Works
 
-AIGNE DocSmith operates on a multi-agent system built within the AIGNE Framework. Instead of a single monolithic process, it orchestrates a pipeline of specialized AI agents, where each agent is responsible for a specific task. This approach allows for a structured and modular process that transforms source code into complete documentation.
+AIGNE DocSmith operates on a multi-agent system. Instead of a single monolithic process, it orchestrates a pipeline of specialized AI agents, where each agent is responsible for a specific task. This approach allows for a structured and modular process that transforms source code into complete documentation.
 
 The tool is an integral part of the larger AIGNE ecosystem, which provides a platform for developing and deploying AI applications.
 
@@ -73,7 +73,7 @@ User-Feedback -> Pipeline.Content-Generation: "Regenerate Content"
 
 1.  **Input Analysis**: The process begins when agents load your source code and project configuration (`aigne.yaml`).
 
-2.  **Structure Planning**: An agent analyzes the codebase to propose a logical document structure. It creates an outline based on the project's composition and any specified rules.
+2.  **Structure Planning**: An agent analyzes the codebase to propose a logical documentation structure. It creates an outline based on the project's composition and any specified rules.
 
 3.  **Content Generation**: With the structure in place, content generation agents populate each section of the document plan with detailed text, code examples, and explanations.
 
@@ -85,14 +85,14 @@ User-Feedback -> Pipeline.Content-Generation: "Regenerate Content"
 
 DocSmith's functionality is provided by a collection of agents defined in the project's configuration. Each agent has a specific role. The table below lists some of the key agents and their functions.
 
-| Functional Role          | Key Agent Files                                      | Description                                                                          |
-| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| **Structure Planning**   | `generate/generate-structure.yaml`                   | Analyzes source code to propose the initial document outline.                        |
-| **Structure Refinement** | `generate/refine-document-structure.yaml`            | Modifies the document structure based on user feedback.                              |
-| **Content Generation**   | `update/batch-generate-document.yaml`, `generate-document.yaml` | Populates the document structure with detailed content for each section.             |
-| **Translation**          | `translate/translate-document.yaml`, `translate-multilingual.yaml` | Translates generated documentation into multiple target languages.                   |
-| **Publishing**           | `publish/publish-docs.mjs`                           | Manages the process of publishing documents to Discuss Kit instances.                |
-| **Data I/O**             | `utils/load-sources.mjs`, `utils/save-docs.mjs`      | Responsible for reading source files and writing the final markdown documents to disk. |
+| Functional Role | Key Agent Files | Description |
+| :--- | :--- | :--- |
+| **Structure Planning** | `generate/generate-structure.yaml` | Analyzes source code to propose the initial document outline. |
+| **Structure Refinement** | `generate/refine-document-structure.yaml` | Modifies the documentation structure based on user feedback. |
+| **Content Generation** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | Populates the documentation structure with detailed content for each section. |
+| **Translation** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | Translates generated documentation into multiple target languages. |
+| **Publishing** | `publish/publish-docs.mjs` | Manages the process of publishing documents to Discuss Kit instances. |
+| **Data I/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | Responsible for reading source files and writing the final markdown documents to disk. |
 
 This agent-based architecture allows each step of the documentation process to be handled by a specialized tool, ensuring a structured and maintainable workflow.
 

package/docs/advanced-how-it-works.zh-TW.md

@@ -1,25 +1,25 @@
 # 運作方式
 
-AIGNE DocSmith 在 AIGNE 框架内建構的多 Agent 系統上運作。它不是單一的整體流程，而是協調一個由專業 AI Agent 組成的管線，其中每個 Agent 負責一項特定任務。這種方法實現了一個結構化和模組化的流程，將原始碼轉換為完整的文件。
+AIGNE DocSmith 運作於一個多 Agent 系統之上。它並非單一的巨型流程，而是協調一個由專業化 AI Agent 組成的流程，其中每個 Agent 負責一項特定任務。這種方法實現了一個結構化和模組化的流程，能將原始程式碼轉換為完整的文件。
 
-該工具是更大的 AIGNE 生態系統中不可或缺的一部分，該生態系統為開發和部署 AI 應用程式提供了一個平台。
+此工具是更廣泛的 AIGNE 生態系統中不可或缺的一部分，該生態系統為開發和部署 AI 應用程式提供了一個平台。
 
 ![AIGNE 生態系統架構](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
-## 文件生成管線
+## 文件產生流程
 
-DocSmith 的核心是一個管線，它透過幾個不同階段處理您的原始碼。每個階段都由一個或多個專門的 Agent 管理。主要工作流程通常由 `aigne doc generate` 命令啟動，可視覺化如下：
+DocSmith 的核心是一個將您的原始程式碼經過數個不同階段處理的流程。每個階段都由一個或多個專門的 Agent 管理。主要的工作流程，通常由 `aigne doc generate` 指令啟動，可視覺化如下：
 
 ```d2
 direction: down
 
 Input: {
-  label: "原始碼與設定檔"
+  label: "原始程式碼與設定"
   shape: rectangle
 }
 
 Pipeline: {
-  label: "核心生成管線"
+  label: "核心產生流程"
   shape: rectangle
   grid-columns: 1
   grid-gap: 40
@@ -30,7 +30,7 @@ Pipeline: {
   }
 
   Content-Generation: {
-    label: "2. 內容生成"
+    label: "2. 內容產生"
     shape: rectangle
   }
 
@@ -46,7 +46,7 @@ User-Feedback: {
 }
 
 Optional-Steps: {
-  label: "可選的生成後步驟"
+  label: "選用的後產生步驟"
   shape: rectangle
   grid-columns: 2
   grid-gap: 40
@@ -68,33 +68,33 @@ Pipeline.Content-Generation -> Pipeline.Saving
 Pipeline.Saving -> Optional-Steps
 
 User-Feedback -> Pipeline.Structure-Planning: "優化結構"
-User-Feedback -> Pipeline.Content-Generation: "重新生成內容"
+User-Feedback -> Pipeline.Content-Generation: "重新產生內容"
 ```
 
-1.  **輸入分析**：當 Agent 載入您的原始碼和專案設定（`aigne.yaml`）時，流程便開始了。
+1.  **輸入分析**：當 Agent 載入您的原始程式碼和專案設定（`aigne.yaml`）時，流程便開始了。
 
-2.  **結構規劃**：一個 Agent 會分析程式碼庫，以提出一個合乎邏輯的文件結構。它會根據專案的組成和任何指定的規則來建立大綱。
+2.  **結構規劃**：一個 Agent 會分析程式庫以提出一個合乎邏輯的文件結構。它會根據專案的組成和任何指定的規則來建立大綱。
 
-3.  **內容生成**：結構就位後，內容生成 Agent 會為文件計畫的每個部分填入詳細的文字、程式碼範例和解釋。
+3.  **內容產生**：結構就緒後，內容產生 Agent 會在文件計畫的每個部分填入詳細的文字、程式碼範例和說明。
 
-4.  **優化與更新**：當您透過 `aigne doc update` 或 `aigne doc generate --feedback` 提供輸入時，會啟動特定的 Agent 來更新個別文件或調整整體結構。
+4.  **優化與更新**：當您透過 `aigne doc update` 或 `aigne doc generate --feedback` 提供輸入時，特定的 Agent 會被啟動以更新個別文件或調整整體結構。
 
-5.  **翻譯與發布**：主要內容生成後，可選的 Agent 會處理多語言翻譯和將最終文件發布到網路平台等任務。
+5.  **翻譯與發布**：主要內容產生後，選用的 Agent 會處理多語言翻譯和將最終文件發布到網路平台等任務。
 
 ## 關鍵 AI Agent
 
-DocSmith 的功能是由專案設定中定義的一系列 Agent 所提供。每個 Agent 都有特定的角色。下表列出了一些關鍵 Agent 及其功能。
+DocSmith 的功能由專案設定中定義的一系列 Agent 提供。每個 Agent 都有特定的角色。下表列出了一些關鍵 Agent 及其功能。
 
-| 功能角色               | 關鍵 Agent 檔案                                      | 描述                                                                         |
-| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| **結構規劃**           | `generate/generate-structure.yaml`                   | 分析原始碼以提出初始的文件大綱。                                             |
-| **結構優化**         | `generate/refine-document-structure.yaml`            | 根據使用者回饋修改文件結構。                                                 |
-| **內容生成**           | `update/batch-generate-document.yaml`, `generate-document.yaml` | 為文件結構的每個部分填入詳細內容。                                           |
-| **翻譯**               | `translate/translate-document.yaml`, `translate-multilingual.yaml` | 將生成的文件翻譯成多個目標語言。                                             |
-| **發布**               | `publish/publish-docs.mjs`                           | 管理將文件發布到 Discuss Kit 實例的過程。                                    |
-| **資料 I/O**           | `utils/load-sources.mjs`, `utils/save-docs.mjs`      | 負責讀取來源檔案並將最終的 Markdown 文件寫入磁碟。                           |
+| 功能角色 | 關鍵 Agent 檔案 | 說明 |
+| :--- | :--- | :--- |
+| **結構規劃** | `generate/generate-structure.yaml` | 分析原始程式碼以提出初始的文件大綱。 |
+| **結構優化** | `generate/refine-document-structure.yaml` | 根據使用者回饋修改文件結構。 |
+| **內容產生** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | 為文件結構的每個部分填入詳細內容。 |
+| **翻譯** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | 將產生的文件翻譯成多個目標語言。 |
+| **發布** | `publish/publish-docs.mjs` | 管理將文件發布到 Discuss Kit 實例的流程。 |
+| **資料 I/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | 負責讀取來源檔案並將最終的 markdown 文件寫入磁碟。 |
 
-這種基於 Agent 的架構使得文件流程的每一步都能由專門的工具處理，從而確保了一個結構化且可維護的工作流程。
+這種基於 Agent 的架構讓文件流程的每一步都由專門的工具處理，確保了工作流程的結構化和可維護性。
 
 ---
 

package/docs/advanced-how-it-works.zh.md

@@ -1,25 +1,25 @@
 # 工作原理
 
-AIGNE DocSmith 在一个构建于 AIGNE 框架内的多 Agent 系统上运行。它并非采用单一的整体流程，而是协调一个由专业 AI Agent 组成的流水线，其中每个 Agent 负责一项特定任务。这种方法使得将源代码转换为完整文档的过程变得结构化且模块化。
+AIGNE DocSmith 在一个多 Agent 系统上运行。它不是一个单一的整体流程，而是协调一个由专门的 AI Agent 组成的管道，其中每个 Agent 负责一项特定任务。这种方法允许通过一个结构化和模块化的流程将源代码转换为完整的文档。
 
-该工具是更宏大的 AIGNE 生态系统的一个组成部分，该生态系统为开发和部署 AI 应用提供了一个平台。
+该工具是更广泛的 AIGNE 生态系统的一个组成部分，该生态系统为开发和部署 AI 应用程序提供了一个平台。
 
 ![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
-## 文档生成流水线
+## 文档生成管道
 
-DocSmith 的核心是一条通过多个不同阶段处理源代码的流水线。每个阶段都由一个或多个专用 Agent 进行管理。主要工作流程通常由 `aigne doc generate` 命令启动，其过程可直观地表示如下：
+DocSmith 的核心是一个通过几个不同阶段处理您的源代码的管道。每个阶段都由一个或多个专用 Agent 管理。主要工作流程通常由 `aigne doc generate` 命令启动，可以可视化如下：
 
 ```d2
 direction: down
 
 Input: {
-  label: "源代码与配置"
+  label: "源代码和配置"
   shape: rectangle
 }
 
 Pipeline: {
-  label: "核心生成流水线"
+  label: "核心生成管道"
   shape: rectangle
   grid-columns: 1
   grid-gap: 40
@@ -73,29 +73,29 @@ User-Feedback -> Pipeline.Content-Generation: "重新生成内容"
 
 1.  **输入分析**：当 Agent 加载您的源代码和项目配置（`aigne.yaml`）时，该过程开始。
 
-2.  **结构规划**：一个 Agent 会分析代码库，以提出一个逻辑化的文档结构。它会根据项目的构成和任何指定的规则创建一个大纲。
+2.  **结构规划**：一个 Agent 分析代码库以提出一个逻辑化的文档结构。它会根据项目的构成和任何指定的规则创建一个大纲。
 
 3.  **内容生成**：结构确定后，内容生成 Agent 会为文档计划的每个部分填充详细的文本、代码示例和解释。
 
-4.  **优化与更新**：当您通过 `aigne doc update` 或 `aigne doc generate --feedback` 提供输入时，特定的 Agent 会被激活以更新单个文档或调整整体结构。
+4.  **优化和更新**：当您通过 `aigne doc update` 或 `aigne doc generate --feedback` 提供输入时，特定的 Agent 会被激活以更新单个文档或调整整体结构。
 
-5.  **翻译与发布**：在主要内容生成后，可选的 Agent 会处理多语言翻译和将最终文档发布到网络平台等任务。
+5.  **翻译和发布**：在主要内容生成后，可选的 Agent 会处理多语言翻译和将最终文档发布到 Web 平台等任务。
 
 ## 关键 AI Agent
 
-DocSmith 的功能由项目配置中定义的一系列 Agent 提供。每个 Agent 都有其特定的角色。下表列出了一些关键 Agent 及其功能。
+DocSmith 的功能由项目配置中定义的一系列 Agent 提供。每个 Agent 都有特定的角色。下表列出了一些关键 Agent 及其功能。
 
-| 功能角色         | 关键 Agent 文件                                      | 描述                                                                          |
-| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| **结构规划**   | `generate/generate-structure.yaml`                   | 分析源代码以提出初始的文档大纲。                        |
-| **结构优化** | `generate/refine-document-structure.yaml`            | 根据用户反馈修改文档结构。                              |
-| **内容生成**   | `update/batch-generate-document.yaml`, `generate-document.yaml` | 为文档结构的每个部分填充详细内容。             |
-| **翻译**          | `translate/translate-document.yaml`, `translate-multilingual.yaml` | 将生成的文档翻译成多种目标语言。                   |
-| **发布**           | `publish/publish-docs.mjs`                           | 管理将文档发布到 Discuss Kit 实例的过程。                |
-| **数据 I/O**             | `utils/load-sources.mjs`, `utils/save-docs.mjs`      | 负责读取源文件并将最终的 Markdown 文档写入磁盘。 |
+| 功能角色 | 关键 Agent 文件 | 描述 |
+| :--- | :--- | :--- |
+| **结构规划** | `generate/generate-structure.yaml` | 分析源代码以提出初始文档大纲。 |
+| **结构优化** | `generate/refine-document-structure.yaml` | 根据用户反馈修改文档结构。 |
+| **内容生成** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | 为文档结构的每个部分填充详细内容。 |
+| **翻译** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | 将生成的文档翻译成多种目标语言。 |
+| **发布** | `publish/publish-docs.mjs` | 管理将文档发布到 Discuss Kit 实例的过程。 |
+| **数据 I/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | 负责读取源文件并将最终的 Markdown 文档写入磁盘。 |
 
-这种基于 Agent 的架构使得文档流程的每一步都能由一个专门的工具来处理，从而确保了工作流程的结构化和可维护性。
+这种基于 Agent 的架构允许文档流程的每一步都由专门的工具处理，从而确保一个结构化且可维护的工作流程。
 
 ---
 
-要了解 DocSmith 为确保输出的准确性和格式所采取的措施，请继续阅读 [质量保证](./advanced-quality-assurance.md) 部分。
+要了解 DocSmith 为确保输出的准确性和格式而采取的措施，请继续阅读[质量保证](./advanced-quality-assurance.md)部分。