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

package/docs/configuration-managing-preferences.md

@@ -1,100 +0,0 @@
-# Managing Preferences
-
-When you generate or update documentation, you can provide feedback using the `--feedback` flag. This feedback is saved as a "preference" to be reused in future sessions, ensuring the AI maintains consistency with your previous instructions. The `aigne doc prefs` command provides a direct way to manage these saved preferences.
-
-This guide details how to list, remove, and toggle the active status of your saved preferences.
-
-## Viewing Saved Preferences
-
-To review all saved preferences, use the `--list` flag. This command displays each preference with its status, scope, unique ID, and content.
-
-```bash
-aigne doc prefs --list
-```
-
-### Understanding the Output
-
-The list is formatted to provide clear information about each preference rule:
-
-*   **Status**: Indicates if a preference is active or inactive.
-    *   `🟢`: Active. The rule will be applied during documentation generation.
-    *   `⚪`: Inactive. The rule is saved but will be ignored.
-*   **Scope**: The context in which the preference applies (e.g., `global`, `document`).
-*   **ID**: A unique identifier for the preference, used for removing or toggling.
-*   **Paths**: If the preference applies only to specific files, their paths are listed here.
-*   **Rule Content**: The text of the preference rule itself.
-
-**Example Output:**
-
-```
-# User Preferences
-
-**Format explanation:**
-- 🟢 = Active preference, ⚪ = Inactive preference
-- [scope] = Preference scope (global, structure, document, translation)
-- ID = Unique preference identifier
-- Paths = Specific file paths (if applicable)
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## Removing Preferences
-
-When a preference is no longer needed, you can permanently delete it using the `--remove` flag. You can remove preferences either by specifying their IDs or through an interactive menu.
-
-### Interactive Mode
-
-To select preferences from a list, run the command without any IDs. This will open an interactive prompt where you can check the items you wish to delete.
-
-```bash
-aigne doc prefs --remove
-```
-
-A checklist will appear, allowing you to select one or more preferences. This is the recommended method for ensuring you remove the correct items.
-
-### Direct Mode
-
-If you already know the unique IDs of the preferences you want to remove, you can specify them using the `--id` flag. This is faster if you are certain about which items to delete.
-
-```bash
-# Remove a single preference
-aigne doc prefs --remove --id 2af5c
-
-# Remove multiple preferences
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## Toggling Preferences
-
-Instead of permanently deleting a preference, you can temporarily enable or disable it. This is useful when you want to suspend a rule for a specific task without losing it. Use the `--toggle` flag to change a preference's active status.
-
-### Interactive Mode
-
-Running the command without IDs will launch an interactive checklist, similar to the remove command.
-
-```bash
-aigne doc prefs --toggle
-```
-
-You can select the preferences you wish to activate or deactivate. The status icon (`🟢`/`⚪`) will update to reflect the new state.
-
-### Direct Mode
-
-To toggle specific preferences directly, use the `--id` flag.
-
-```bash
-# Toggle a single preference
-aigne doc prefs --toggle --id 2af5c
-
-# Toggle multiple preferences
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-By managing your preferences, you can maintain fine-grained control over the documentation generation process, ensuring that the output consistently aligns with your project's specific requirements and style.

package/docs/configuration-managing-preferences.zh-TW.md

@@ -1,100 +0,0 @@
-# 管理偏好設定
-
-當您生成或更新文件時，可以使用 `--feedback` 旗標提供回饋。此回饋會儲存為「偏好設定」，以便在未來的會話中重複使用，確保 AI 與您先前的指示保持一致。`aigne doc prefs` 指令提供了一種直接管理這些已儲存偏好設定的方法。
-
-本指南詳細說明如何列出、移除以及切換您已儲存偏好設定的啟用狀態。
-
-## 檢視已儲存的偏好設定
-
-若要檢視所有已儲存的偏好設定，請使用 `--list` 旗標。此指令會顯示每個偏好設定的狀態、範圍、唯一 ID 和內容。
-
-```bash
-aigne doc prefs --list
-```
-
-### 理解輸出內容
-
-列表經過格式化，以提供關於每個偏好設定規則的清晰資訊：
-
-*   **Status**：指示偏好設定為啟用或停用。
-    *   `🟢`：啟用。此規則將在文件生成期間應用。
-    *   `⚪`：停用。此規則已儲存但將被忽略。
-*   **Scope**：偏好設定應用的情境（例如：`global`、`document`）。
-*   **ID**：偏好設定的唯一識別碼，用於移除或切換狀態。
-*   **Paths**：如果偏好設定僅適用於特定檔案，其路徑會在此列出。
-*   **Rule Content**：偏好設定規則本身的文字。
-
-**輸出範例：**
-
-```
-# 使用者偏好設定
-
-**格式說明：**
-- 🟢 = 啟用中的偏好設定，⚪ = 停用中的偏好設定
-- [scope] = 偏好設定範圍 (global, structure, document, translation)
-- ID = 唯一的偏好設定識別碼
-- Paths = 特定檔案路徑（如果適用）
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## 移除偏好設定
-
-當不再需要某個偏好設定時，您可以使用 `--remove` 旗標將其永久刪除。您可以透過指定其 ID 或透過互動式選單來移除偏好設定。
-
-### 互動模式
-
-若要從列表中選擇偏好設定，請執行不含任何 ID 的指令。這將開啟一個互動式提示，您可以在其中勾選您希望刪除的項目。
-
-```bash
-aigne doc prefs --remove
-```
-
-會出現一個清單，讓您選擇一個或多個偏好設定。這是確保您移除正確項目的建議方法。
-
-### 直接模式
-
-如果您已經知道要移除的偏好設定的唯一 ID，您可以使用 `--id` 旗標來指定它們。如果您確定要刪除哪些項目，這種方式會更快。
-
-```bash
-# 移除單一偏好設定
-aigne doc prefs --remove --id 2af5c
-
-# 移除多個偏好設定
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## 切換偏好設定
-
-您可以暫時啟用或停用偏好設定，而不是永久刪除它。當您想為特定任務暫停某個規則而不想失去它時，這非常有用。使用 `--toggle` 旗標來變更偏好設定的啟用狀態。
-
-### 互動模式
-
-執行不含 ID 的指令將會啟動一個互動式清單，類似於移除指令。
-
-```bash
-aigne doc prefs --toggle
-```
-
-您可以選擇您希望啟用或停用的偏好設定。狀態圖示 (`🟢`/`⚪`) 將會更新以反映新的狀態。
-
-### 直接模式
-
-若要直接切換特定偏好設定，請使用 `--id` 旗標。
-
-```bash
-# 切換單一偏好設定
-aigne doc prefs --toggle --id 2af5c
-
-# 切換多個偏好設定
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-透過管理您的偏好設定，您可以對文件生成過程進行細緻的控制，確保輸出結果能持續符合您專案的特定要求和風格。

package/docs/configuration-managing-preferences.zh.md

@@ -1,100 +0,0 @@
-# 管理偏好设置
-
-在生成或更新文档时，您可以使用 `--feedback` 标志提供反馈。此反馈将作为“偏好设置”保存，以便在未来的会话中重复使用，确保 AI 与您之前的指令保持一致。`aigne doc prefs` 命令提供了一种直接管理这些已保存偏好设置的方法。
-
-本指南详细介绍了如何列出、删除和切换已保存偏好设置的活动状态。
-
-## 查看已保存的偏好设置
-
-要查看所有已保存的偏好设置，请使用 `--list` 标志。此命令会显示每个偏好设置的状态、范围、唯一 ID 和内容。
-
-```bash
-aigne doc prefs --list
-```
-
-### 理解输出
-
-列表经过格式化，以提供关于每个偏好规则的清晰信息：
-
-*   **状态**：指示偏好设置是活动还是非活动状态。
-    *   `🟢`：活动。该规则将在文档生成期间应用。
-    *   `⚪`：非活动。该规则已保存但将被忽略。
-*   **范围**：偏好设置适用的上下文（例如，`global`、`document`）。
-*   **ID**：偏好设置的唯一标识符，用于删除或切换状态。
-*   **路径**：如果偏好设置仅适用于特定文件，其路径会在此处列出。
-*   **规则内容**：偏好规则本身的文本。
-
-**输出示例：**
-
-```
-# 用户偏好设置
-
-**格式说明：**
-- 🟢 = 活动偏好，⚪ = 非活动偏好
-- [scope] = 偏好范围 (global, structure, document, translation)
-- ID = 唯一偏好标识符
-- Paths = 特定文件路径（如适用）
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## 删除偏好设置
-
-当不再需要某个偏好设置时，您可以使用 `--remove` 标志将其永久删除。您可以通过指定其 ID 或通过交互式菜单来删除偏好设置。
-
-### 交互模式
-
-要从列表中选择偏好设置，请在不带任何 ID 的情况下运行该命令。这将打开一个交互式提示，您可以在其中勾选要删除的项目。
-
-```bash
-aigne doc prefs --remove
-```
-
-将出现一个清单，允许您选择一个或多个偏好设置。这是确保您删除正确项目的推荐方法。
-
-### 直接模式
-
-如果您已经知道要删除的偏好设置的唯一 ID，可以使用 `--id` 标志来指定它们。如果您确定要删除哪些项目，这种方式会更快。
-
-```bash
-# 删除单个偏好设置
-aigne doc prefs --remove --id 2af5c
-
-# 删除多个偏好设置
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## 切换偏好设置
-
-除了永久删除偏好设置，您还可以临时启用或禁用它。当您想为特定任务暂停某条规则但又不想丢失它时，这非常有用。使用 `--toggle` 标志来更改偏好设置的活动状态。
-
-### 交互模式
-
-在不带 ID 的情况下运行该命令将启动一个交互式清单，类似于删除命令。
-
-```bash
-aigne doc prefs --toggle
-```
-
-您可以选择希望激活或停用的偏好设置。状态图标（`🟢`/`⚪`）将更新以反映新状态。
-
-### 直接模式
-
-要直接切换特定偏好设置，请使用 `--id` 标志。
-
-```bash
-# 切换单个偏好设置
-aigne doc prefs --toggle --id 2af5c
-
-# 切换多个偏好设置
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-通过管理您的偏好设置，您可以对文档生成过程进行精细控制，确保输出始终符合您项目的特定要求和风格。

package/docs/configuration.ja.md

@@ -1,96 +0,0 @@
-# 設定
-
-適切な設定は、プロジェクト固有のニーズに合わせてドキュメント生成プロセスを調整するために不可欠です。AIGNE DocSmithは、主要な設定ファイルとコマンドラインインターフェースを使用して設定を管理します。このセットアップにより、生成されるドキュメントがプロジェクトの目標、対象読者、構造的要件を正確に反映することが保証されます。
-
-このセクションでは、ツールの設定方法の概要を説明します。ステップバイステップの手順については、以下の詳細なガイドを参照してください。
-
-<x-cards>
-  <x-card data-title="初期設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">対話式セットアップを実行して `config.yaml` ファイルを作成する方法を学びます。これは、新しいプロジェクトで推奨される最初のステップです。</x-card>
-  <x-card data-title="設定の管理" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">保存された設定を表示、有効化、無効化、または削除する方法を理解し、時間とともにドキュメント生成プロセスを洗練させます。</x-card>
-</x-cards>
-
-## `config.yaml` ファイル
-
-すべてのプロジェクトレベルの設定は、プロジェクト内の `.aigne/doc-smith/` ディレクトリにある `config.yaml` という名前のファイルに保存されます。`aigne doc init` コマンドは、対話的なプロセスを通じてこのファイルを作成します。また、いつでもテキストエディタでこのファイルを手動で変更して設定を調整することもできます。
-
-以下は `config.yaml` ファイルの例で、各セクションを説明するコメントが付いています。
-
-```yaml Example config.yaml icon=logos:yaml
-# ドキュメント公開のためのプロジェクト情報
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmithは、AIGNEフレームワーク上に構築された強力なAI駆動のドキュメント生成ツールです。ソースコードから直接、詳細で構造化された多言語のドキュメント作成を自動化します。
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# ドキュメント設定
-# =============================================================================
-
-# 目的: 読者に達成してもらいたい主な成果は何ですか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   getStarted       - 迅速な開始：新規ユーザーが30分未満でゼロから作業を開始できるように支援します
-#   completeTasks    - 特定のタスクの完了：一般的なワークフローとユースケースを通じてユーザーをガイドします
-#   findAnswers      - 迅速な回答の検索：すべての機能とAPIに対して検索可能なリファレンスを提供します
-#   understandSystem - システムの理解：システムの仕組み、設計上の決定理由を説明します
-#   solveProblems    - 問題の解決：ユーザーのトラブルシューティングと問題修正を支援します
-#   mixedPurpose     - 上記の混合：複数のニーズをカバーする包括的なドキュメント
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 対象読者: 主に誰がこれを読みますか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   endUsers         - エンドユーザー（非技術者）：製品を使用するがコーディングはしない人々
-#   developers       - 統合開発者：これを自分のプロジェクトに追加するエンジニア
-#   devops           - DevOps/インフラストラクチャ：システムをデプロイ、監視、維持するチーム
-#   decisionMakers   - 技術的な意思決定者：実装を評価または計画するアーキテクト、リーダー
-#   supportTeams     - サポートチーム：他者が製品を使用するのを助ける人々
-#   mixedTechnical   - 混合技術者層：開発者、DevOps、および技術ユーザー
-targetAudienceTypes:
-  - endUsers
-
-# 読者の知識レベル: 読者が訪れたときに通常何を知っていますか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   completeBeginners    - 完全な初心者：この分野/技術に全く新しい人々
-#   domainFamiliar       - 分野に精通、ツールは初めて：問題領域は知っているが、この特定のソリューションは初めて
-#   experiencedUsers     - 経験豊富なユーザー：リファレンス/高度なトピックを必要とする通常のユーザー
-#   emergencyTroubleshooting - 緊急/トラブルシューティング：何かが壊れており、迅速に修正する必要がある
-#   exploringEvaluating  - 探索/評価：これが自分のニーズに合うかどうかを理解しようとしている
-readerKnowledgeLevel: completeBeginners
-
-# ドキュメントの深さ: ドキュメントはどの程度包括的であるべきですか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   essentialOnly      - 必須事項のみ：80%のユースケースをカバーし、簡潔に保つ
-#   balancedCoverage   - バランスの取れたカバレッジ：実践的な例を伴う適切な深さ [推奨]
-#   comprehensive      - 包括的：すべての機能、エッジケース、および高度なシナリオをカバーする
-#   aiDecide           - AIに決定させる：コードの複雑さを分析し、適切な深さを提案する
-documentationDepth: comprehensive
-
-# カスタムルール: 特定のドキュメント生成ルールと要件を定義します
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# 対象読者: 特定の対象読者とその特徴を記述します
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 生成されたドキュメントを保存するディレクトリ
-sourcesPath:  # 分析するソースコードのパス
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
-
-## まとめ
-
-設定が完了すると、ツールはプロジェクト、対象読者、ドキュメントの目標を明確に理解し、より正確で関連性の高いコンテンツが生成されます。
-
-プロジェクトの設定を開始するには、[初期設定](./configuration-initial-setup.md) ガイドに進んでください。

package/docs/configuration.md

@@ -1,96 +0,0 @@
-# Configuration
-
-Proper configuration is essential for tailoring the documentation generation process to your project's specific needs. AIGNE DocSmith uses a primary configuration file and a command-line interface to manage your settings. This setup ensures that the generated documentation accurately reflects your project's goals, target audience, and structural requirements.
-
-This section provides an overview of how to configure the tool. For step-by-step instructions, please refer to the following detailed guides:
-
-<x-cards>
-  <x-card data-title="Initial Setup" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">Learn how to run the interactive setup to create your config.yaml file. This is the recommended first step for any new project.</x-card>
-  <x-card data-title="Managing Preferences" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">Understand how to view, enable, disable, or delete saved preferences to refine the documentation generation process over time.</x-card>
-</x-cards>
-
-## The `config.yaml` File
-
-All project-level settings are stored in a file named `config.yaml`, located in the `.aigne/doc-smith/` directory within your project. The `aigne doc init` command creates this file for you through an interactive process. You can also modify this file manually with a text editor to adjust settings at any time.
-
-Below is an example of a `config.yaml` file, with comments explaining each section.
-
-```yaml Example config.yaml icon=logos:yaml
-# Project information for documentation publishing
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# Documentation Configuration
-# =============================================================================
-
-# Purpose: What's the main outcome you want readers to achieve?
-# Available options (uncomment and modify as needed):
-#   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, why design decisions were made
-#   solveProblems    - Solve problems: Help users troubleshoot and fix issues
-#   mixedPurpose     - Mix of above: Comprehensive documentation covering multiple needs
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# Target Audience: Who will be reading this most often?
-# Available options (uncomment and modify as needed):
-#   endUsers         - End users (non-technical): People who use the product but don't code
-#   developers       - Developers integrating: Engineers adding this to their projects
-#   devops           - DevOps/Infrastructure: Teams deploying, monitoring, maintaining systems
-#   decisionMakers   - Technical decision makers: Architects, leads evaluating or planning implementation
-#   supportTeams     - Support teams: People helping others use the product
-#   mixedTechnical   - Mixed technical audience: Developers, DevOps, and technical users
-targetAudienceTypes:
-  - endUsers
-
-# Reader Knowledge Level: What do readers typically know when they arrive?
-# Available options (uncomment and modify as needed):
-#   completeBeginners    - Complete beginners: New to this domain/technology entirely
-#   domainFamiliar       - Domain-familiar, tool-new: Know the problem space, new to this specific solution
-#   experiencedUsers     - Experienced users: Regular users needing reference/advanced topics
-#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
-#   exploringEvaluating  - Exploring/evaluating: Trying to understand if this fits their needs
-readerKnowledgeLevel: completeBeginners
-
-# Documentation Depth: How comprehensive should the documentation be?
-# Available options (uncomment and modify as needed):
-#   essentialOnly      - Essential only: Cover the 80% use cases, keep it concise
-#   balancedCoverage   - Balanced coverage: Good depth with practical examples [RECOMMENDED]
-#   comprehensive      - Comprehensive: Cover all features, edge cases, and advanced scenarios
-#   aiDecide           - Let AI decide: Analyze code complexity and suggest appropriate depth
-documentationDepth: comprehensive
-
-# Custom Rules: Define specific documentation generation rules and requirements
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# Target Audience: Describe your specific target audience and their characteristics
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
-
-## Summary
-
-With your configuration in place, the tool will have a clear understanding of your project, audience, and documentation goals, resulting in more accurate and relevant content.
-
-To begin setting up your project, proceed to the [Initial Setup](./configuration-initial-setup.md) guide.

package/docs/configuration.zh-TW.md

@@ -1,96 +0,0 @@
-# 設定
-
-正確的設定對於根據專案的特定需求客製化文件產生過程至關重要。AIGNE DocSmith 使用一個主要設定檔和一個命令列介面來管理您的設定。這種設定方式確保產生的文件能準確反映您的專案目標、目標受眾和結構需求。
-
-本節概述了如何設定此工具。有關逐步說明，請參閱以下詳細指南：
-
-<x-cards>
-  <x-card data-title="初始設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何執行互動式設定來建立您的 config.yaml 檔案。這是任何新專案的建議第一步。</x-card>
-  <x-card data-title="管理偏好設定" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何檢視、啟用、停用或刪除已儲存的偏好設定，以隨著時間的推移來完善文件產生過程。</x-card>
-</x-cards>
-
-## `config.yaml` 檔案
-
-所有專案層級的設定都儲存在名為 `config.yaml` 的檔案中，該檔案位於您專案內的 `.aigne/doc-smith/` 目錄中。`aigne doc init` 指令會透過一個互動式過程為您建立此檔案。您也可以隨時使用文字編輯器手動修改此檔案以調整設定。
-
-以下是一個 `config.yaml` 檔案的範例，其中包含解釋每個區塊的註解。
-
-```yaml Example config.yaml icon=logos:yaml
-# 用於文件發布的專案資訊
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文件設定
-# =============================================================================
-
-# 目的：您希望讀者達成的最主要成果是什麼？
-# 可用選項（取消註解並根據需要修改）：
-#   getStarted       - 快速入門：幫助新使用者在 30 分鐘內從零到上手
-#   completeTasks    - 完成特定任務：引導使用者完成常見的工作流程和使用案例
-#   findAnswers      - 快速尋找答案：為所有功能和 API 提供可搜尋的參考資料
-#   understandSystem - 了解系統：解釋其運作方式及設計決策的原因
-#   solveProblems    - 解決問題：幫助使用者進行故障排除並修復問題
-#   mixedPurpose     - 綜合目的：涵蓋多種需求的綜合性文件
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目標受眾：誰會最常閱讀這份文件？
-# 可用選項（取消註解並根據需要修改）：
-#   endUsers         - 終端使用者（非技術人員）：使用產品但不寫程式的人
-#   developers       - 整合開發者：將此產品加入其專案的工程師
-#   devops           - DevOps/基礎設施：部署、監控、維護系統的團隊
-#   decisionMakers   - 技術決策者：評估或規劃實施的架構師、領導者
-#   supportTeams     - 支援團隊：幫助他人使用產品的人員
-#   mixedTechnical   - 混合技術受眾：開發者、DevOps 和技術使用者
-targetAudienceTypes:
-  - endUsers
-
-# 讀者知識水平：讀者在閱讀文件時通常具備哪些知識？
-# 可用選項（取消註解並根據需要修改）：
-#   completeBeginners    - 完全初學者：對此領域/技術完全陌生
-#   domainFamiliar       - 熟悉領域，工具新手：了解問題領域，但對此特定解決方案不熟
-#   experiencedUsers     - 有經驗的使用者：需要參考資料/進階主題的常規使用者
-#   emergencyTroubleshooting - 緊急/故障排除：出現問題，需要快速修復
-#   exploringEvaluating  - 探索/評估：試圖了解這是否符合他們的需求
-readerKnowledgeLevel: completeBeginners
-
-# 文件深度：文件應該要多詳盡？
-# 可用選項（取消註解並根據需要修改）：
-#   essentialOnly      - 僅涵蓋必要內容：涵蓋 80% 的使用案例，保持簡潔
-#   balancedCoverage   - 平衡的涵蓋範圍：具有足夠深度和實用範例 [建議]
-#   comprehensive      - 全面詳盡：涵蓋所有功能、邊界案例和進階情境
-#   aiDecide           - 讓 AI 決定：分析程式碼複雜度並建議適當的深度
-documentationDepth: comprehensive
-
-# 自訂規則：定義特定的文件產生規則與要求
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# 目標受眾：描述您的特定目標受眾及其特徵
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 儲存產生文件的目錄
-sourcesPath:  # 要分析的原始碼路徑
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
-
-## 總結
-
-完成設定後，此工具將清楚了解您的專案、受眾和文件目標，從而產生更準確、更相關的內容。
-
-若要開始設定您的專案，請前往 [初始設定](./configuration-initial-setup.md) 指南。