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

package/agents/utils/transform-detail-datasources.mjs

@@ -1,25 +1,21 @@
+import fs from "node:fs";
 import { normalizePath, toRelativePath } from "../../utils/utils.mjs";
 
-export default function transformDetailDatasources({ sourceIds, datasourcesList }) {
-  // Build a map for fast lookup, with path normalization for compatibility
-  const dsMap = Object.fromEntries(
-    (datasourcesList || []).map((ds) => {
-      const normalizedSourceId = normalizePath(ds.sourceId);
-      return [normalizedSourceId, ds.content];
-    }),
-  );
-
-  // Collect formatted contents in order, with path normalization
+export default function transformDetailDatasources({ sourceIds }) {
+  // Read file content for each sourceId, ignoring failures
   const contents = (sourceIds || [])
-    .filter((id) => {
-      const normalizedId = normalizePath(id);
-      return dsMap[normalizedId];
-    })
     .map((id) => {
-      const normalizedId = normalizePath(id);
-      const relativeId = toRelativePath(id);
-      return `// sourceId: ${relativeId}\n${dsMap[normalizedId]}\n`;
-    });
+      try {
+        const normalizedId = normalizePath(id);
+        const content = fs.readFileSync(normalizedId, "utf8");
+        const relativeId = toRelativePath(id);
+        return `// sourceId: ${relativeId}\n${content}\n`;
+      } catch {
+        // Ignore files that cannot be read
+        return null;
+      }
+    })
+    .filter(Boolean);
 
   return { detailDataSources: contents.join("") };
 }

package/aigne.yaml

@@ -11,6 +11,7 @@ agents:
 
   # Documentation Structure Generation
   - ./agents/generate/generate-structure.yaml
+  - ./agents/generate/generate-structure-without-tools.yaml
   - ./agents/generate/update-document-structure.yaml
   - ./agents/generate/check-need-generate-structure.mjs
   - ./agents/generate/refine-document-structure.yaml
@@ -54,6 +55,7 @@ agents:
   - ./agents/clear/clear-generated-docs.mjs
   - ./agents/clear/clear-document-config.mjs
   - ./agents/clear/clear-auth-tokens.mjs
+  - ./agents/clear/clear-deployment-config.mjs
 
   # Utilities
   - ./agents/utils/load-sources.mjs

package/biome.json

@@ -60,7 +60,7 @@
   },
   "overrides": [
     {
-      "includes": ["**/fixtures/**"],
+      "includes": ["**/fixtures/**", ".aigne/doc-smith/output/structure-plan.json"],
 
       "linter": {
         "enabled": false

package/docs/_sidebar.md

@@ -1,17 +1,15 @@
 * [Overview](/overview.md)
 * [Getting Started](/getting-started.md)
-* [Core Features](/features.md)
-  * [Generate Documentation](/features-generate-documentation.md)
-  * [Update and Refine](/features-update-and-refine.md)
-  * [Translate Documentation](/features-translate-documentation.md)
-  * [Publish Your Docs](/features-publish-your-docs.md)
-* [CLI Command Reference](/cli-reference.md)
-* [Configuration Guide](/configuration.md)
-  * [LLM Setup](/configuration-llm-setup.md)
-  * [Language Support](/configuration-language-support.md)
-  * [Managing Preferences](/configuration-preferences.md)
-  * [Interactive Setup](/configuration-interactive-setup.md)
-* [Advanced Topics](/advanced.md)
-  * [How It Works](/advanced-how-it-works.md)
-  * [Quality Assurance](/advanced-quality-assurance.md)
-* [Changelog](/changelog.md)
+* [Guides](/guides.md)
+  * [Generating Documentation](/guides-generating-documentation.md)
+  * [Updating Documentation](/guides-updating-documentation.md)
+  * [Translating Documentation](/guides-translating-documentation.md)
+  * [Publishing Your Docs](/guides-publishing-your-docs.md)
+  * [Managing History](/guides-managing-history.md)
+  * [Evaluating Documents](/guides-evaluating-documents.md)
+  * [Cleaning Up](/guides-cleaning-up.md)
+  * [Interactive Chat](/guides-interactive-chat.md)
+* [Configuration](/configuration.md)
+  * [Initial Setup](/configuration-initial-setup.md)
+  * [Managing Preferences](/configuration-managing-preferences.md)
+* [Release Notes](/release-notes.md)

package/docs/configuration-initial-setup.ja.md

@@ -0,0 +1,179 @@
+# 初期設定
+
+このガイドでは、AIGNE DocSmith の対話型セットアッププロセスをステップバイステップで説明します。このプロセスは、`generate` コマンドを初めて実行する際に開始されるか、手動で開始することもできます。その目的は、ドキュメント生成の設定を保存する `config.yaml` ファイルを作成することです。
+
+## プロセスの開始
+
+設定を手動で開始するには、ターミナルでプロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
+
+```bash
+aigne doc init
+```
+
+このコマンドは対話式の質問を起動し、ドキュメント設定の構成をガイドします。
+
+## 設定手順
+
+セットアッププロセスは、特定のニーズに合わせてドキュメントを調整するために設計された 9 つの質問で構成されています。
+
+### ステップ 1: ドキュメントの目的を定義する
+
+最初に、ドキュメントの主な目的を定義するよう求められます。この選択は、生成されるコンテンツのトーン、構造、および焦点に影響を与えます。
+
+**プロンプト:** `📝 [1/9]: What should your documentation help readers achieve?`
+
+以下のリストから複数のオプションを選択できます。
+
+| オプション | 名前 | 説明 |
+| :--- | :--- | :--- |
+| `getStarted` | 迅速な利用開始 | 新規ユーザーが 30 分以内にゼロから作業を開始できるよう支援します。 |
+| `completeTasks` | 特定のタスクの完了 | 一般的なワークフローとユースケースをユーザーに案内します。 |
+| `findAnswers` | 迅速な回答の検索 | すべての機能と API の検索可能なリファレンスを提供します。 |
+| `understandSystem` | システムの理解 | システムの仕組みと設計決定の背後にある理由を説明します。 |
+| `solveProblems` | 問題の解決 | ユーザーが問題をトラブルシューティングし、修正するのを助けます。 |
+| `mixedPurpose` | 上記の組み合わせ | 複数のニーズを包括的にカバーします。 |
+
+### ステップ 2: 対象読者を特定する
+
+次に、ドキュメントの主な読者を指定します。これにより、言語と技術的な深さを適切に調整できます。
+
+**プロンプト:** `👥 [2/9]: Who will be reading your documentation?`
+
+以下の読者から 1 つ以上を選択できます。
+
+| オプション | 名前 | 説明 |
+| :--- | :--- | :--- |
+| `endUsers` | エンドユーザー (非技術者) | 製品を使用するがコーディングはしない人々。 |
+| `developers` | 統合開発者 | これを自分のプロジェクトに追加するエンジニア。 |
+| `devops` | DevOps/インフラストラクチャ | システムをデプロイ、監視、保守するチーム。 |
+| `decisionMakers` | 技術的な意思決定者 | テクノロジーを評価するアーキテクトやリード。 |
+| `supportTeams` | サポートチーム | 他の人が製品を使用するのを助ける人々。 |
+| `mixedTechnical` | 混合技術読者層 | 開発者、DevOps、その他の技術ユーザーの組み合わせ。 |
+
+### ステップ 3: カスタムルールを提供する
+
+このオプションのステップでは、コンテンツ生成中に AI が従うべき特定の指示や制約を提供できます。
+
+**プロンプト:** `📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
+
+トーン、スタイル、除外するコンテンツなど、特定の要件を入力できます。例: 「マーケティング用語の使用を避け、技術的な正確さに焦点を当てる。」
+
+### ステップ 4: 読者の知識レベルを指定する
+
+読者の想定される知識レベルを示してください。これにより、コンテンツが簡単すぎず、複雑すぎず、適切なレベルで提供されることが保証されます。
+
+**プロンプト:** `🧠 [4/9]: How much do readers already know about your project?`
+
+読者に最も合うオプションを選択してください。
+
+| オプション | 名前 | 説明 |
+| :--- | :--- | :--- |
+| `completeBeginners` | 完全な初心者 | ドメインやテクノロジーに全く慣れていない。 |
+| `domainFamiliar` | ドメインには詳しいが、ツールは初めて | 問題領域は知っているが、このソリューションは初めて。 |
+| `experiencedUsers` | 経験豊富なユーザー | リファレンスや高度なトピックを必要とする通常のユーザー。 |
+| `emergencyTroubleshooting` | 緊急/トラブルシューティング | 問題を迅速に解決する必要があるユーザー。 |
+| `exploringEvaluating` | 探索/評価中 | ツールが自分のニーズに合うかどうかを判断しようとしているユーザー。 |
+
+### ステップ 5: ドキュメントの深さを設定する
+
+ドキュメントをどれだけ詳細にするかを選択します。これにより、生成されるコンテンツの範囲と詳細レベルが決まります。
+
+**プロンプト:** `📊 [5/9]: How detailed should your documentation be?`
+
+以下の詳細レベルから 1 つを選択してください。
+
+| オプション | 名前 | 説明 |
+| :--- | :--- | :--- |
+| `essentialOnly` | 不可欠なもののみ | 最も一般的な 80% のユースケースを簡潔にカバーします。 |
+| `balancedCoverage` | バランスの取れたカバレッジ | 実用的な例とともに十分な深さを提供します。 |
+| `comprehensive` | 包括的 | すべての機能、エッジケース、高度なシナリオをカバーします。 |
+| `aiDecide` | AI に決定させる | ツールがコードの複雑さを分析し、適切な深さを提案します。 |
+
+### ステップ 6: 主要言語を選択する
+
+ドキュメントの主要言語を選択します。システムはオペレーティングシステムの言語を検出し、デフォルトとして提案します。
+
+**プロンプト:** `🌐 [6/9]: What's your main documentation language?`
+
+英語、中国語 (簡体字)、スペイン語を含む 12 のサポートされている言語のリストが表示されます。
+
+### ステップ 7: 翻訳言語を選択する
+
+ドキュメントを翻訳したい追加の言語を選択します。
+
+**プロンプト:** `🔄 [7/9]: Which languages should we translate to?`
+
+前のステップで選択した主要言語を除き、サポートされているオプションのリストから複数の言語を選択できます。
+
+### ステップ 8: 出力ディレクトリを定義する
+
+生成されたドキュメントファイルを保存するフォルダを指定します。
+
+**プロンプト:** `📁 [8/9]: Where should we save your documentation?`
+
+デフォルトのパスは `.aigne/doc-smith/docs` です。これを受け入れるか、別のパスを提供することができます。
+
+### ステップ 9: コンテンツソースを指定する
+
+ドキュメントを生成するためにツールが分析すべきファイルとフォルダを指定します。複数のパスを追加したり、高度なフィルタリングのために glob パターンを使用したりできます。
+
+**プロンプト:** `🔍 [9/9]: Content Sources`
+
+ファイルパス、フォルダパス、または glob パターン (例: `src/**/*.js`) を入力するよう求められます。パスを指定しない場合、ツールはデフォルトでプロジェクトディレクトリ全体を分析します。
+
+## 生成された設定ファイル
+
+質問に回答し終えると、DocSmith はあなたの回答を `.aigne/doc-smith/` ディレクトリにある `config.yaml` という名前の設定ファイルに保存します。このファイルは、将来のすべてのドキュメント生成の設計図として機能し、いつでも手動で編集できます。
+
+以下は、生成された `config.yaml` ファイルの例です。
+
+```yaml config.yaml title="config.yaml"
+# ドキュメント公開用のプロジェクト情報
+projectName: AIGNE DocSmith
+projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
+
+# =============================================================================
+# ドキュメント設定
+# =============================================================================
+
+# 目的: 読者に達成してほしい主な成果は何か？
+documentPurpose:
+  - getStarted
+  - completeTasks
+
+# 対象読者: 誰がこれを最も頻繁に読むか？
+targetAudienceTypes:
+  - endUsers
+
+# 読者の知識レベル: 読者は通常、どのような知識を持っているか？
+readerKnowledgeLevel: completeBeginners
+
+# ドキュメントの深さ: ドキュメントはどの程度包括的であるべきか？
+documentationDepth: comprehensive
+
+# カスタムルール: 特定のドキュメント生成ルールと要件を定義する
+rules: |
+  Avoid using vague or empty words...
+
+# 対象読者: 特定の対象読者とその特徴を記述する
+targetAudience: |
+  
+# 言語設定
+locale: en
+translateLanguages:
+  - zh
+  - ja
+
+# ディレクトリとソースパスの設定
+docsDir: ./docs  # 生成されたドキュメントを保存するディレクトリ
+sourcesPath:  # 分析するソースコードのパス
+  - ./README.md
+  - ./agents
+```
+
+## 次のステップ
+
+初期設定が完了し、ドキュメントを作成する準備が整いました。
+
+*   [ドキュメントの生成](./guides-generating-documentation.md) ガイドに進み、生成プロセスの実行方法を学びましょう。

package/docs/configuration-initial-setup.md

@@ -0,0 +1,179 @@
+# Initial Setup
+
+This guide provides a step-by-step walkthrough of the interactive setup process for AIGNE DocSmith. This process is initiated the first time you run the `generate` command, or it can be started manually. Its purpose is to create a `config.yaml` file that stores your preferences for generating documentation.
+
+## Starting the Process
+
+To manually begin the configuration, navigate to your project's root directory in your terminal and execute the following command:
+
+```bash
+aigne doc init
+```
+
+This command launches an interactive questionnaire that will guide you through configuring your documentation settings.
+
+## Configuration Steps
+
+The setup process consists of nine questions designed to tailor the documentation to your specific needs.
+
+### Step 1: Define Documentation Purpose
+
+You will first be asked to define the primary goals of your documentation. This selection influences the tone, structure, and focus of the generated content.
+
+**Prompt:** `📝 [1/9]: What should your documentation help readers achieve?`
+
+You can select multiple options from the list below:
+
+| Option | Name | Description |
+| :--- | :--- | :--- |
+| `getStarted` | Get started quickly | Help new users go from zero to working in <30 minutes. |
+| `completeTasks` | Complete specific tasks | Guide users through common workflows and use cases. |
+| `findAnswers` | Find answers fast | Provide searchable reference for all features and APIs. |
+| `understandSystem` | Understand the system | Explain how it works and the reasoning behind design decisions. |
+| `solveProblems` | Solve problems | Help users troubleshoot and fix issues. |
+| `mixedPurpose` | Mix of above | Cover multiple needs comprehensively. |
+
+### Step 2: Identify Target Audience
+
+Next, specify who will be the primary readers of your documentation. This helps tailor the language and technical depth appropriately.
+
+**Prompt:** `👥 [2/9]: Who will be reading your documentation?`
+
+You can select one or more of the following audiences:
+
+| Option | Name | Description |
+| :--- | :--- | :--- |
+| `endUsers` | End users (non-technical) | People who use the product but do not code. |
+| `developers` | Developers integrating | Engineers adding this to their projects. |
+| `devops` | DevOps/Infrastructure | Teams deploying, monitoring, and maintaining systems. |
+| `decisionMakers` | Technical decision makers | Architects or leads evaluating the technology. |
+| `supportTeams` | Support teams | People helping others use the product. |
+| `mixedTechnical` | Mixed technical audience | A combination of developers, DevOps, and other technical users. |
+
+### Step 3: Provide Custom Rules
+
+This optional step allows you to provide specific instructions or constraints for the AI to follow during content generation.
+
+**Prompt:** `📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
+
+You can input any specific requirements, such as tone, style, or content to exclude. For example: "Avoid using marketing language and focus on technical accuracy."
+
+### Step 4: Specify Reader Knowledge Level
+
+Indicate the assumed knowledge level of your audience. This ensures the content is pitched at the right level, without being too basic or too complex.
+
+**Prompt:** `🧠 [4/9]: How much do readers already know about your project?`
+
+Select the option that best describes your readers:
+
+| Option | Name | Description |
+| :--- | :--- | :--- |
+| `completeBeginners` | Complete beginners | New to the domain or technology entirely. |
+| `domainFamiliar` | Domain-familiar, tool-new | Know the problem space but are new to this solution. |
+| `experiencedUsers` | Experienced users | Regular users who need reference or advanced topics. |
+| `emergencyTroubleshooting` | Emergency/troubleshooting | Users who need to fix a problem quickly. |
+| `exploringEvaluating` | Exploring/evaluating | Users trying to determine if the tool fits their needs. |
+
+### Step 5: Set Documentation Depth
+
+Choose how detailed the documentation should be. This determines the scope and level of detail in the generated content.
+
+**Prompt:** `📊 [5/9]: How detailed should your documentation be?`
+
+Select one of the following levels of detail:
+
+| Option | Name | Description |
+| :--- | :--- | :--- |
+| `essentialOnly` | Essential only | Covers the most common 80% of use cases concisely. |
+| `balancedCoverage` | Balanced coverage | Provides good depth with practical examples. |
+| `comprehensive` | Comprehensive | Covers all features, edge cases, and advanced scenarios. |
+| `aiDecide` | Let AI decide | The tool analyzes code complexity to suggest an appropriate depth. |
+
+### Step 6: Select Primary Language
+
+Choose the main language for your documentation. The system will detect your operating system's language and suggest it as the default.
+
+**Prompt:** `🌐 [6/9]: What's your main documentation language?`
+
+You will be presented with a list of 12 supported languages, including English, Chinese (Simplified), and Spanish.
+
+### Step 7: Choose Translation Languages
+
+Select any additional languages you want the documentation to be translated into.
+
+**Prompt:** `🔄 [7/9]: Which languages should we translate to?`
+
+You can choose multiple languages from the list of supported options, excluding the primary language you selected in the previous step.
+
+### Step 8: Define Output Directory
+
+Specify the folder where the generated documentation files should be saved.
+
+**Prompt:** `📁 [8/9]: Where should we save your documentation?`
+
+The default path is `.aigne/doc-smith/docs`. You can accept this or provide a different path.
+
+### Step 9: Specify Content Sources
+
+Indicate which files and folders the tool should analyze to generate documentation. You can add multiple paths and use glob patterns for advanced filtering.
+
+**Prompt:** `🔍 [9/9]: Content Sources`
+
+You will be prompted to enter file paths, folder paths, or glob patterns (e.g., `src/**/*.js`). If you do not provide any paths, the tool will analyze the entire project directory by default.
+
+## Generated Configuration File
+
+After completing the questionnaire, DocSmith saves your responses to a configuration file named `config.yaml` in the `.aigne/doc-smith/` directory. This file serves as the blueprint for all future documentation generation and can be manually edited at any time.
+
+Here is an example of a generated `config.yaml` file:
+
+```yaml config.yaml title="config.yaml"
+# Project information for documentation publishing
+projectName: AIGNE DocSmith
+projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
+
+# =============================================================================
+# Documentation Configuration
+# =============================================================================
+
+# Purpose: What's the main outcome you want readers to achieve?
+documentPurpose:
+  - getStarted
+  - completeTasks
+
+# Target Audience: Who will be reading this most often?
+targetAudienceTypes:
+  - endUsers
+
+# Reader Knowledge Level: What do readers typically know when they arrive?
+readerKnowledgeLevel: completeBeginners
+
+# Documentation Depth: How comprehensive should the documentation be?
+documentationDepth: comprehensive
+
+# Custom Rules: Define specific documentation generation rules and requirements
+rules: |
+  Avoid using vague or empty words...
+
+# Target Audience: Describe your specific target audience and their characteristics
+targetAudience: |
+  
+# Language settings
+locale: en
+translateLanguages:
+  - zh
+  - ja
+
+# Directory and source path configurations
+docsDir: ./docs  # Directory to save generated documentation
+sourcesPath:  # Source code paths to analyze
+  - ./README.md
+  - ./agents
+```
+
+## Next Steps
+
+With your initial configuration complete, you are now ready to create your documentation.
+
+*   Proceed to the [Generating Documentation](./guides-generating-documentation.md) guide to learn how to run the generation process.

package/docs/configuration-initial-setup.zh-TW.md

@@ -0,0 +1,179 @@
+# 初始設定
+
+本指南將逐步引導您完成 AIGNE DocSmith 的互動式設定流程。此流程會在您首次執行 `generate` 指令時啟動，也可以手動開始。其目的是建立一個 `config.yaml` 檔案，用來儲存您產生文件的偏好設定。
+
+## 開始流程
+
+若要手動開始設定，請在終端機中導覽至您的專案根目錄，並執行以下指令：
+
+```bash
+aigne doc init
+```
+
+此指令會啟動一個互動式問卷，引導您完成文件設定。
+
+## 設定步驟
+
+設定流程包含九個問題，旨在根據您的特定需求量身打造文件。
+
+### 步驟 1：定義文件目的
+
+首先，系統會請您定義文件的主要目標。這項選擇會影響所產生內容的語氣、結構和重點。
+
+**提示：** `📝 [1/9]：您的文件應幫助讀者達成什麼目標？`
+
+您可以從下表中選取多個選項：
+
+| 選項 | 名稱 | 描述 |
+| :--- | :--- | :--- |
+| `getStarted` | 快速入門 | 幫助新使用者在 30 分鐘內從零到上手。 |
+| `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
+| `findAnswers` | 快速尋找答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
+| `understandSystem` | 了解系統 | 解釋其運作方式以及設計決策背後的原因。 |
+| `solveProblems` | 解決問題 | 幫助使用者進行疑難排解和修復問題。 |
+| `mixedPurpose` | 以上混合 | 全面涵蓋多種需求。 |
+
+### 步驟 2：識別目標讀者
+
+接著，請指定文件的主要讀者是誰。這有助於適當地調整語言和技術深度。
+
+**提示：** `👥 [2/9]：誰會閱讀您的文件？`
+
+您可以選取以下一種或多種讀者群：
+
+| 選項 | 名稱 | 描述 |
+| :--- | :--- | :--- |
+| `endUsers` | 終端使用者（非技術人員） | 使用產品但不寫程式的人。 |
+| `developers` | 進行整合的開發者 | 將此產品加入其專案的工程師。 |
+| `devops` | DevOps/基礎架構人員 | 部署、監控和維護系統的團隊。 |
+| `decisionMakers` | 技術決策者 | 評估此技術的架構師或主管。 |
+| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
+| `mixedTechnical` | 混合技術背景的讀者 | 開發者、DevOps 和其他技術使用者的組合。 |
+
+### 步驟 3：提供自訂規則
+
+這個選填步驟讓您可以提供特定的指示或限制，供 AI 在內容生成過程中遵循。
+
+**提示：** `📋 [3/9]：您的文件是否有任何自訂規則或要求？（選填，按 Enter 鍵跳過）`
+
+您可以輸入任何特定要求，例如語氣、風格或要排除的內容。例如：「避免使用行銷語言，並專注於技術準確性。」
+
+### 步驟 4：指定讀者知識水平
+
+請指出您讀者群的預設知識水平。這能確保內容的難易度適中，不會過於基礎或過於複雜。
+
+**提示：** `🧠 [4/9]：讀者對您的專案已經了解多少？`
+
+請選擇最能描述您讀者的選項：
+
+| 選項 | 名稱 | 描述 |
+| :--- | :--- | :--- |
+| `completeBeginners` | 完全的初學者 | 完全不熟悉該領域或技術。 |
+| `domainFamiliar` | 熟悉領域，但對工具陌生 | 了解問題領域，但對此解決方案是新手。 |
+| `experiencedUsers` | 有經驗的使用者 | 需要參考資料或進階主題的常規使用者。 |
+| `emergencyTroubleshooting` | 緊急/疑難排解 | 需要快速解決問題的使用者。 |
+| `exploringEvaluating` | 探索/評估 | 試圖判斷此工具是否符合其需求的使用者。 |
+
+### 步驟 5：設定文件深度
+
+選擇文件的詳細程度。這決定了所產生內容的範圍和詳細程度。
+
+**提示：** `📊 [5/9]：您的文件應該多詳細？`
+
+請選擇以下其中一個詳細程度：
+
+| 選項 | 名稱 | 描述 |
+| :--- | :--- | :--- |
+| `essentialOnly` | 僅含必要內容 | 簡潔地涵蓋 80% 最常見的使用案例。 |
+| `balancedCoverage` | 均衡的涵蓋範圍 | 提供具備實用範例的良好深度。 |
+| `comprehensive` | 全面詳盡 | 涵蓋所有功能、邊界案例和進階情境。 |
+| `aiDecide` | 讓 AI 決定 | 工具會分析程式碼的複雜度，以建議適當的深度。 |
+
+### 步驟 6：選擇主要語言
+
+選擇文件的主要語言。系統會偵測您作業系統的語言，並建議其為預設語言。
+
+**提示：** `🌐 [6/9]：您的主要文件語言是什麼？`
+
+系統將會顯示一份包含 12 種支援語言的清單，包括英語、簡體中文和西班牙語。
+
+### 步驟 7：選擇翻譯語言
+
+選擇您希望將文件翻譯成的其他語言。
+
+**提示：** `🔄 [7/9]：我們應該將文件翻譯成哪些語言？`
+
+您可以從支援的選項清單中選擇多種語言，不包括您在上一步驟中選擇的主要語言。
+
+### 步驟 8：定義輸出目錄
+
+指定儲存所產生文件檔案的資料夾。
+
+**提示：** `📁 [8/9]：我們應該將您的文件儲存在哪裡？`
+
+預設路徑為 `.aigne/doc-smith/docs`。您可以接受此路徑或提供不同的路徑。
+
+### 步驟 9：指定內容來源
+
+指出工具應分析哪些檔案和資料夾以產生文件。您可以新增多個路徑，並使用 glob 模式進行進階篩選。
+
+**提示：** `🔍 [9/9]：內容來源`
+
+系統會提示您輸入檔案路徑、資料夾路徑或 glob 模式（例如 `src/**/*.js`）。如果您未提供任何路徑，工具預設會分析整個專案目錄。
+
+## 產生的設定檔
+
+完成問卷後，DocSmith 會將您的回答儲存到位於 `.aigne/doc-smith/` 目錄中名為 `config.yaml` 的設定檔。此檔案將作為未來所有文件產生的藍圖，並且可以隨時手動編輯。
+
+以下是一個產生的 `config.yaml` 檔案範例：
+
+```yaml config.yaml title="config.yaml"
+# 文件發布的專案資訊
+projectName: AIGNE DocSmith
+projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
+
+# =============================================================================
+# 文件設定
+# =============================================================================
+
+# 目的：您希望讀者達成的最主要成果是什麼？
+documentPurpose:
+  - getStarted
+  - completeTasks
+
+# 目標讀者：誰最常閱讀此文件？
+targetAudienceTypes:
+  - endUsers
+
+# 讀者知識水平：讀者在閱讀文件時通常具備哪些知識？
+readerKnowledgeLevel: completeBeginners
+
+# 文件深度：文件應該多全面？
+documentationDepth: comprehensive
+
+# 自訂規則：定義特定的文件產生規則和要求
+rules: |
+  Avoid using vague or empty words...
+
+# 目標讀者：描述您的特定目標讀者及其特徵
+targetAudience: |
+  
+# 語言設定
+locale: en
+translateLanguages:
+  - zh
+  - ja
+
+# 目錄和來源路徑設定
+docsDir: ./docs  # 儲存所產生文件的目錄
+sourcesPath:  # 要分析的原始碼路徑
+  - ./README.md
+  - ./agents
+```
+
+## 後續步驟
+
+初始設定完成後，您現在可以開始建立文件了。
+
+*   請前往 [產生文件](./guides-generating-documentation.md) 指南，了解如何執行產生流程。