@aigne/doc-smith 0.8.11-beta → 0.8.11-beta.2

package/docs/configuration-preferences.zh.md

@@ -1,16 +1,16 @@
-# 管理偏好
+# 管理偏好设置
 
-AIGNE DocSmith 旨在通过你的反馈进行学习。当你优化或更正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好。这些规则确保你特定的风格、结构要求和内容策略在未来的文档任务中得到一致应用。所有偏好都存储在项目根目录下一个名为 `.aigne/doc-smith/preferences.yml` 的人类可读 YAML 文件中。
+AIGNE DocSmith 旨在从您的反馈中学习。当您优化或更正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好设置。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致的应用。所有偏好设置都存储在项目根目录下一个人类可读的 YAML 文件中，路径为 `.aigne/doc-smith/preferences.yml`。
 
-## 偏好生命周期
+## 偏好设置的生命周期
 
-下图说明了你的反馈如何成为一个可重用的规则，该规则可应用于未来的任务，并可通过命令行进行管理。
+下图说明了您的反馈如何成为一个可重用的规则，该规则可以应用于未来的任务，并可以通过命令行进行管理。
 
-```d2 偏好生命周期
+```d2 偏好设置的生命周期
 direction: down
 
 feedback: {
-  label: "1. 用户在“优化”或“翻译”期间提供反馈"
+  label: "1. 用户在“优化”或“翻译”期间\n提供反馈"
   shape: rectangle
 }
 
@@ -30,7 +30,7 @@ pref_file: {
 }
 
 future_tasks: {
-  label: "4. 未来任务\n应用已保存的规则"
+  label: "4. 未来的任务\n应用已保存的规则"
   shape: rectangle
 }
 
@@ -48,82 +48,82 @@ cli <-> pref_file: "管理"
 
 ```
 
-### 如何创建偏好
+### 如何创建偏好设置
 
-当你在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析你的输入。它会判断该反馈是一次性修复（例如，更正一个拼写错误）还是一个可重用的策略（例如，“始终用英语编写代码注释”）。如果它代表一个持久性指令，它就会创建一个新的偏好规则。
+当您在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析您的输入。它会判断反馈是一次性修复（例如，更正拼写错误）还是可重用的策略（例如，“始终用英语编写代码注释”）。如果它代表一个持久的指令，它就会创建一个新的偏好设置规则。
 
 ### 规则属性
 
 保存在 `preferences.yml` 中的每个规则都具有以下结构：
 
 <x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
-<x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。未启用的规则在生成任务期间将被忽略。"></x-field>
-<x-field data-name="scope" data-type="string" data-desc="定义规则何时应用。有效范围为 'global'、'structure'、'document' 或 'translation'。"></x-field>
-<x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、提炼后的指令。"></x-field>
+<x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。在生成任务期间，非活动规则将被忽略。"></x-field>
+<x-field data-name="scope" data-type="string" data-desc="定义规则应在何时应用。有效范围是 'global'、'structure'、'document' 或 'translation'。"></x-field>
+<x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、精炼的指令。"></x-field>
 <x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈，保留以供参考。"></x-field>
 <x-field data-name="createdAt" data-type="string" data-desc="表示规则创建时间的 ISO 8601 时间戳。"></x-field>
 <x-field data-name="paths" data-type="string[]" data-required="false" data-desc="一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定源文件生成的内容。"></x-field>
 
-## 使用 CLI 管理偏好
+## 使用 CLI 管理偏好设置
 
-你可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好。这允许你列出、激活、停用或永久删除规则。
+您可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好设置。这允许您列出、激活、停用或永久删除规则。
 
-### 列出所有偏好
+### 列出所有偏好设置
 
-要查看所有已保存的偏好，包括已激活和未激活的，请使用 `--list` 标志。
+要查看所有已保存的偏好设置（包括活动的和非活动的），请使用 `--list` 标志。
 
-```bash 列出所有偏好 icon=lucide:terminal
+```bash 列出所有偏好设置 icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-该命令会显示一个格式化列表，展示每个规则的状态、范围、ID 以及任何路径限制。
+该命令会显示一个格式化的列表，显示每个规则的状态、范围、ID 和任何路径限制。
 
-```text 输出示例 icon=lucide:clipboard-list
-# 用户偏好
+```text 示例输出 icon=lucide:clipboard-list
+# 用户偏好设置
 
 **格式说明：**
-- 🟢 = 已激活的偏好, ⚪ = 未激活的偏好
-- [scope] = 偏好范围 (global, structure, document, translation)
-- ID = 唯一偏好标识符
-- Paths = 特定文件路径 (如果适用)
+- 🟢 = 活动偏好设置，⚪ = 非活动偏好设置
+- [scope] = 偏好设置范围 (global, structure, document, translation)
+- ID = 唯一偏好设置标识符
+- Paths = 特定文件路径（如果适用）
 
 🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   在概览文档末尾添加“后续步骤”部分。
+   在概述文档的末尾添加一个“后续步骤”部分。
  
 ⚪ [document] pref_i9j0k1l2m3n4o5p6
    代码注释必须用英语编写。
 ```
 
-### 停用和重新激活偏好
+### 停用和重新激活偏好设置
 
-如果你想临时禁用一个规则而不删除它，可以使用 `--toggle` 标志来切换其激活状态。不带 ID 运行该命令将启动一个交互模式，允许你选择一个或多个偏好进行切换。
+如果您想暂时禁用某个规则而不删除它，可以使用 `--toggle` 标志来切换其活动状态。在不带 ID 的情况下运行该命令将启动交互模式，允许您选择一个或多个偏好设置进行切换。
 
-```bash 以交互方式切换偏好 icon=lucide:terminal
+```bash 以交互方式切换偏好设置 icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
 要直接切换特定规则，请使用 `--id` 标志提供其 ID。这对应于 `deactivateRule` 函数，该函数将规则的 `active` 属性设置为 `false`。
 
-```bash 切换特定偏好 icon=lucide:terminal
+```bash 切换特定偏好设置 icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 ```
 
-### 删除偏好
+### 删除偏好设置
 
-要永久删除一个或多个偏好，请使用 `--remove` 标志。此操作对应于 `removeRule` 函数，且无法撤销。
+要永久删除一个或多个偏好设置，请使用 `--remove` 标志。此操作对应于 `removeRule` 函数，且无法撤销。
 
-要进入交互式选择提示，请不带 ID 运行该命令。
+要进入交互式选择提示，请在不带 ID 的情况下运行该命令。
 
-```bash 以交互方式删除偏好 icon=lucide:terminal
+```bash 以交互方式删除偏好设置 icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-要通过 ID 直接删除特定规则，请使用 `--id` 标志。
+要通过其 ID 直接删除特定规则，请使用 `--id` 标志。
 
-```bash 删除特定偏好 icon=lucide:terminal
+```bash 删除特定偏好设置 icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 ```
 
 ## 后续步骤
 
-管理偏好是根据项目特定需求定制 DocSmith 的关键部分。有关更多自定义选项，请查阅主要的[配置指南](./configuration.md)。
+管理偏好设置是根据项目特定需求定制 DocSmith 的关键部分。要了解更多自定义选项，请探索主要的[配置指南](./configuration.md)。

package/docs/configuration.ja.md

@@ -0,0 +1,172 @@
+# 設定ガイド
+
+AIGNE DocSmithの動作は、`.aigne/doc-smith/config.yaml`に配置されている中央ファイル、`config.yaml`によって制御されます。このファイルは、ドキュメントのスタイル、対象読者、言語、構造を決定します。
+
+`aigne doc init`を実行することで、対話式セットアップウィザードを使用してこのファイルを作成および管理できます。ステップバイステップのウォークスルーについては、[対話式セットアップ](./configuration-interactive-setup.md)ガイドを参照してください。
+
+## 主要な設定エリア
+
+ドキュメントは、いくつかの主要な設定エリアによって形成されます。これらのガイドを参照して、生成プロセスの各側面を微調整する方法を理解してください。
+
+<x-cards data-columns="2">
+  <x-card data-title="対話式セットアップ" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
+    設定の推奨や競合の検出を含む、ドキュメントプロジェクトの設定を支援するガイド付きウィザードについて学びます。
+  </x-card>
+  <x-card data-title="LLMセットアップ" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
+    APIキーを必要としない組み込みのAIGNE Hubの使用を含む、さまざまなAIモデルの接続方法を発見します。
+  </x-card>
+  <x-card data-title="言語サポート" data-icon="lucide:languages" data-href="/configuration/language-support">
+    サポートされている言語の完全なリストを確認し、主要言語の設定方法や自動翻訳を有効にする方法を学びます。
+  </x-card>
+  <x-card data-title="設定の管理" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
+    DocSmithがフィードバックを使用して永続的なルールを作成する方法と、CLIを介してそれらを管理する方法を理解します。
+  </x-card>
+</x-cards>
+
+## パラメータリファレンス
+
+`config.yaml`ファイルには、ドキュメントの出力を制御するいくつかのキーと値のペアが含まれています。以下は、各パラメータの詳細なリファレンスです。
+
+### プロジェクト情報
+
+これらの設定は、プロジェクトに関する基本的なコンテキストを提供し、ドキュメントを公開する際に使用されます。
+
+| Parameter | Description |
+|---|---|
+| `projectName` | プロジェクトの名前。`package.json`が存在する場合、そこから検出されます。 |
+| `projectDesc` | プロジェクトの短い説明。`package.json`から検出されます。 |
+| `projectLogo` | プロジェクトのロゴ画像へのパスまたはURL。 |
+
+### ドキュメンテーション戦略
+
+これらのパラメータは、生成されるコンテンツのトーン、スタイル、深さを定義します。
+
+#### `documentPurpose`
+読者に達成してほしい主要な成果を定義します。この設定は、ドキュメント全体の構造と焦点に影響を与えます。
+
+| Option | Name | Description |
+|---|---|---|
+| `getStarted` | すぐに始める | 新規ユーザーが30分未満でゼロから作業を開始できるように支援します。 |
+| `completeTasks` | 特定のタスクを完了する | 一般的なワークフローとユースケースを通じてユーザーをガイドします。 |
+| `findAnswers` | 素早く回答を見つける | すべての機能とAPIに対して検索可能なリファレンスを提供します。 |
+| `understandSystem`| システムを理解する | それがどのように機能し、なぜ設計上の決定がなされたのかを説明します。 |
+| `solveProblems` | 一般的な問題をトラブルシューティングする | ユーザーが問題をトラブルシューティングし、修正するのを支援します。 |
+| `mixedPurpose` | 複数の目的を果たす | 複数のニーズをカバーするドキュメント。 |
+
+#### `targetAudienceTypes`
+このドキュメントを最も頻繁に読む人を定義します。この選択は、ライティングスタイルと例に影響を与えます。
+
+| Option | Name | Description |
+|---|---|---|
+| `endUsers` | エンドユーザー（非技術者） | 製品を使用するがコーディングはしない人々。 |
+| `developers` | 製品/APIを統合する開発者 | これを自分たちのプロジェクトに追加するエンジニア。 |
+| `devops` | DevOps / SRE / インフラストラクチャチーム | システムのデプロイ、監視、保守を行うチーム。 |
+| `decisionMakers`| 技術的な意思決定者 | 実装を評価または計画するアーキテクトやリード。 |
+| `supportTeams` | サポートチーム | 他者が製品を使用するのを助ける人々。 |
+| `mixedTechnical`| 混合技術者層 | 開発者、DevOps、およびその他の技術ユーザー。 |
+
+#### `readerKnowledgeLevel`
+読者がアクセスした時点で通常知っていることを定義します。これにより、どの程度の基礎知識が前提とされるかが調整されます。
+
+| Option | Name | Description |
+|---|---|---|
+| `completeBeginners` | 完全な初心者、ゼロから始める | このドメイン/技術に全くの初心者。 |
+| `domainFamiliar` | 以前に類似のツールを使用したことがある | 問題領域は知っているが、この特定のソリューションには新しい。 |
+| `experiencedUsers` | 特定のことをしようとしている専門家 | リファレンスや高度なトピックを必要とする通常のユーザー。 |
+| `emergencyTroubleshooting`| 緊急/トラブルシューティング | 何かが壊れており、迅速に修正する必要がある。 |
+| `exploringEvaluating` | このツールを他と比較して評価している | これが自分たちのニーズに合うかどうかを理解しようとしている。 |
+
+#### `documentationDepth`
+ドキュメントがどれだけ包括的であるべきかを定義します。
+
+| Option | Name | Description |
+|---|---|---|
+| `essentialOnly` | 必須のみ | 80%のユースケースをカバーし、簡潔に保ちます。 |
+| `balancedCoverage`| バランスの取れたカバレッジ | 実践的な例を伴う適切な深さ [推奨]。 |
+| `comprehensive` | 包括的 | すべての機能、エッジケース、および高度なシナリオをカバーします。 |
+| `aiDecide` | AIに決定させる | コードの複雑さを分析し、適切な深さを提案します。 |
+
+### カスタムディレクティブ
+
+より詳細な制御のために、自由記述の指示を提供できます。
+
+| Parameter | Description |
+|---|---|
+| `rules` | 特定のドキュメント生成ルールを定義できる複数行の文字列（例：「常にパフォーマンスベンチマークを含める」）。 |
+| `targetAudience`| プリセットで許可されているよりも詳細に特定の対象読者を記述するための複数行の文字列。 |
+
+### 言語とパスの設定
+
+これらの設定は、ローカリゼーションとファイルの場所を制御します。
+
+| Parameter | Description |
+|---|---|
+| `locale` | ドキュメントの主要言語（例：`en`、`zh`）。 |
+| `translateLanguages` | ドキュメントを翻訳する言語コードのリスト（例：`[ja, fr, es]`）。 |
+| `docsDir` | 生成されたドキュメントファイルが保存されるディレクトリ。 |
+| `sourcesPath` | DocSmithが分析するためのソースコードパスまたはglobパターンのリスト（例：`['./src', './lib/**/*.js']`）。 |
+| `glossary` | 一貫した翻訳を保証するために、プロジェクト固有の用語を含むマークダウンファイル（`@glossary.md`）へのパス。 |
+
+## config.yamlの例
+
+以下は、完全な設定ファイルの例です。このファイルを直接編集して、いつでも設定を変更できます。
+
+```yaml Example config.yaml icon=logos:yaml
+# ドキュメント公開のためのプロジェクト情報
+projectName: AIGNE DocSmith
+projectDesc: AI駆動のドキュメンテーション生成ツール。
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+
+# =============================================================================
+# ドキュメンテーション設定
+# =============================================================================
+
+# 目的：読者に達成してほしい主要な成果は何か？
+# オプション：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+documentPurpose:
+  - completeTasks
+  - findAnswers
+
+# 対象読者：誰がこれを最も頻繁に読むか？
+# オプション：endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+targetAudienceTypes:
+  - developers
+
+# 読者の知識レベル：読者は通常、何を知ってアクセスするか？
+# オプション：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
+readerKnowledgeLevel: domainFamiliar
+
+# ドキュメントの深さ：ドキュメントはどれだけ包括的であるべきか？
+# オプション：essentialOnly, balancedCoverage, comprehensive, aiDecide
+documentationDepth: balancedCoverage
+
+# カスタムルール：特定のドキュメント生成ルールと要件を定義する
+rules: |+
+  
+
+# 対象読者：特定の対象読者とその特徴を記述する
+targetAudience: |+
+  
+
+# 用語集：プロジェクト固有の用語と定義を含むマークダウンファイルへのパス
+# glossary: "@glossary.md"
+
+# ドキュメントの主要言語
+locale: en
+
+# ドキュメントを翻訳する言語のリスト
+# translateLanguages:
+#   - zh
+#   - fr
+
+# 生成されたドキュメントを保存するディレクトリ
+docsDir: .aigne/doc-smith/docs
+
+# 分析するソースコードパス
+sourcesPath:
+  - ./
+```
+
+設定が完了したら、プロジェクトのニーズに合ったドキュメントを作成する準備が整いました。次のステップは、生成コマンドを実行することです。
+
+➡️ **次へ:** [ドキュメントの生成](./features-generate-documentation.md)

package/docs/configuration.zh-TW.md

@@ -0,0 +1,172 @@
+# 設定指南
+
+AIGNE DocSmith 的行為由一個中央檔案控制，即位於 `.aigne/doc-smith/config.yaml` 的 `config.yaml`。此檔案決定了您文件的風格、目標受眾、語言和結構。
+
+您可以透過執行 `aigne doc init`，使用互動式設定精靈來建立和管理此檔案。有關逐步說明，請參閱 [互動式設定](./configuration-interactive-setup.md) 指南。
+
+## 核心設定區域
+
+您的文件由幾個關鍵的設定區域塑造而成。探索這些指南，以了解如何微調生成過程的每個方面。
+
+<x-cards data-columns="2">
+  <x-card data-title="互動式設定" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
+    了解引導式精靈如何幫助您設定文件專案，包括設定建議和衝突偵測。
+  </x-card>
+  <x-card data-title="LLM 設定" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
+    探索如何連接不同的 AI 模型，包括使用內建的 AIGNE Hub，該中心無需 API 金鑰。
+  </x-card>
+  <x-card data-title="語言支援" data-icon="lucide:languages" data-href="/configuration/language-support">
+    查看支援的語言完整列表，並了解如何設定主要語言和啟用自動翻譯。
+  </x-card>
+  <x-card data-title="管理偏好設定" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
+    了解 DocSmith 如何利用您的回饋來建立持久性規則，以及如何透過 CLI 管理它們。
+  </x-card>
+</x-cards>
+
+## 參數參考
+
+`config.yaml` 檔案包含數個控制文件輸出的鍵值對。以下是每個參數的詳細參考。
+
+### 專案資訊
+
+這些設定提供了有關您專案的基本背景資訊，用於發布文件。
+
+| 參數 | 說明 |
+|---|---|
+| `projectName` | 您的專案名稱。如果 `package.json` 存在，將從中偵測。 |
+| `projectDesc` | 您的專案簡短描述。從 `package.json` 偵測。 |
+| `projectLogo` | 您的專案標誌圖片的路徑或 URL。 |
+
+### 文件策略
+
+這些參數定義了生成內容的語氣、風格和深度。
+
+#### `documentPurpose`
+定義您希望讀者達成的​​主要成果。此設定會影響文件的整體結構和重點。
+
+| 選項 | 名稱 | 說明 |
+|---|---|---|
+| `getStarted` | 快速入門 | 幫助新使用者在 30 分鐘內從零開始上手。 |
+| `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
+| `findAnswers` | 快速找到答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
+| `understandSystem`| 了解系統 | 解釋其運作方式以及設計決策的原因。 |
+| `solveProblems` | 解決常見問題 | 幫助使用者排除故障並解決問題。 |
+| `mixedPurpose` | 服務多種目的 | 涵蓋多種需求的文件。 |
+
+#### `targetAudienceTypes`
+定義最常閱讀此文件的對象。此選擇會影響寫作風格和範例。
+
+| 選項 | 名稱 | 說明 |
+|---|---|---|
+| `endUsers` | 終端使用者（非技術人員） | 使用產品但不編寫程式碼的人。 |
+| `developers` | 整合您的產品/API 的開發人員 | 將此添加到其專案中的工程師。 |
+| `devops` | DevOps / SRE / 基礎設施團隊 | 部署、監控和維護系統的團隊。 |
+| `decisionMakers`| 技術決策者 | 評估或規劃實施的架構師或主管。 |
+| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
+| `mixedTechnical`| 混合技術受眾 | 開發人員、DevOps 和其他技術使用者。 |
+
+#### `readerKnowledgeLevel`
+定義讀者通常在接觸文件時已具備的知識。這會調整文件中假設的基礎知識量。
+
+| 選項 | 名稱 | 說明 |
+|---|---|---|
+| `completeBeginners` | 完全是初學者，從零開始 | 完全不熟悉此領域/技術。 |
+| `domainFamiliar` | 以前使用過類似工具 | 了解問題領域，但對此特定解決方案不熟悉。 |
+| `experiencedUsers` | 是專家，試圖做一些特定的事情 | 需要參考資料或進階主題的常規使用者。 |
+| `emergencyTroubleshooting`| 緊急/故障排除 | 有東西壞了，需要快速修復。 |
+| `exploringEvaluating` | 正在將此工具與其他工具進行評估 | 試圖了解這是否符合他們的需求。 |
+
+#### `documentationDepth`
+定義文件的全面程度。
+
+| 選項 | 名稱 | 說明 |
+|---|---|---|
+| `essentialOnly` | 僅包含必要內容 | 涵蓋 80% 的使用案例，保持簡潔。 |
+| `balancedCoverage`| 均衡的涵蓋範圍 | 具有良好深度和實用範例 [推薦]。 |
+| `comprehensive` | 全面 | 涵蓋所有功能、邊緣案例和進階場景。 |
+| `aiDecide` | 讓 AI 決定 | 分析程式碼複雜性並建議適當的深度。 |
+
+### 自訂指令
+
+為了更精細的控制，您可以提供自由文字指令。
+
+| 參數 | 說明 |
+|---|---|
+| `rules` | 一個多行字串，您可以在其中定義特定的文件生成規則（例如，「始終包含效能基準測試」）。 |
+| `targetAudience`| 一個多行字串，用以比預設選項更詳細地描述您的特定目標受眾。 |
+
+### 語言與路徑設定
+
+這些設定控制本地化和檔案位置。
+
+| 參數 | 說明 |
+|---|---|
+| `locale` | 文件的主要語言（例如，`en`、`zh`）。 |
+| `translateLanguages` | 要將文件翻譯成的語言代碼列表（例如，`[ja, fr, es]`）。 |
+| `docsDir` | 儲存生成文件的目錄。 |
+| `sourcesPath` | 供 DocSmith 分析的原始碼路徑或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
+| `glossary` | 包含專案特定術語的 markdown 檔案（`@glossary.md`）路徑，以確保翻譯一致。 |
+
+## config.yaml 範例
+
+這是一個完整的設定檔範例。您可以隨時直接編輯此檔案以變更設定。
+
+```yaml Example config.yaml icon=logos:yaml
+# 用於文件發布的專案資訊
+projectName: AIGNE DocSmith
+projectDesc: 一個由 AI 驅動的文件生成工具。
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+
+# =============================================================================
+# 文件設定
+# =============================================================================
+
+# 目的：您希望讀者達成的​​主要成果是什麼？
+# 選項：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+documentPurpose:
+  - completeTasks
+  - findAnswers
+
+# 目標受眾：誰最常閱讀此文件？
+# 選項：endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+targetAudienceTypes:
+  - developers
+
+# 讀者知識水平：讀者通常在接觸文件時已具備什麼知識？
+# 選項：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
+readerKnowledgeLevel: domainFamiliar
+
+# 文件深度：文件應該有多全面？
+# 選項：essentialOnly, balancedCoverage, comprehensive, aiDecide
+documentationDepth: balancedCoverage
+
+# 自訂規則：定義特定的文件生成規則和要求
+rules: |+
+  
+
+# 目標受眾：描述您的特定目標受眾及其特徵
+targetAudience: |+
+  
+
+# 詞彙表：包含專案特定術語和定義的 markdown 檔案路徑
+# glossary: "@glossary.md"
+
+# 文件的主要語言
+locale: en
+
+# 要將文件翻譯成的語言列表
+# translateLanguages:
+#   - zh
+#   - fr
+
+# 儲存生成文件的目錄
+docsDir: .aigne/doc-smith/docs
+
+# 要分析的原始碼路徑
+sourcesPath:
+  - ./
+```
+
+設定完成後，您就可以開始建立符合您專案需求的文件了。下一步是執行生成指令。
+
+➡️ **下一步：** [生成文件](./features-generate-documentation.md)