@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.aigne/doc-smith/config.yaml +3 -1
- package/.aigne/doc-smith/output/structure-plan.json +2 -2
- package/.aigne/doc-smith/preferences.yml +28 -20
- package/.aigne/doc-smith/upload-cache.yaml +702 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +22 -2
- package/README.md +2 -2
- package/agents/clear/choose-contents.mjs +2 -2
- package/agents/clear/clear-document-structure.mjs +8 -8
- package/agents/clear/index.yaml +1 -1
- package/agents/evaluate/document-structure.yaml +1 -1
- package/agents/generate/check-document-structure.yaml +3 -3
- package/agents/generate/check-need-generate-structure.mjs +8 -8
- package/agents/generate/document-structure-tools/add-document.mjs +38 -13
- package/agents/generate/document-structure-tools/delete-document.mjs +37 -14
- package/agents/generate/document-structure-tools/move-document.mjs +46 -19
- package/agents/generate/document-structure-tools/update-document.mjs +39 -12
- package/agents/generate/generate-structure.yaml +1 -1
- package/agents/generate/update-document-structure.yaml +3 -9
- package/agents/generate/user-review-document-structure.mjs +15 -14
- package/agents/translate/translate-document.yaml +1 -9
- package/agents/update/batch-generate-document.yaml +1 -1
- package/agents/update/check-document.mjs +2 -2
- package/agents/update/check-update-is-single.mjs +2 -1
- package/agents/update/document-tools/update-document-content.mjs +24 -14
- package/agents/update/fs-tools/glob.mjs +184 -0
- package/agents/update/fs-tools/grep.mjs +317 -0
- package/agents/update/fs-tools/read-file.mjs +307 -0
- package/agents/update/generate-document.yaml +4 -7
- package/agents/update/update-document-detail.yaml +6 -10
- package/agents/update/user-review-document.mjs +13 -13
- package/agents/utils/check-feedback-refiner.mjs +1 -1
- package/agents/utils/choose-docs.mjs +1 -1
- package/agents/utils/load-document-all-content.mjs +3 -3
- package/agents/utils/load-sources.mjs +1 -1
- package/agents/utils/save-docs.mjs +7 -28
- package/aigne.yaml +2 -2
- package/assets/screenshots/doc-complete-setup.png +0 -0
- package/assets/screenshots/doc-generate-docs.png +0 -0
- package/assets/screenshots/doc-generate.png +0 -0
- package/assets/screenshots/doc-generated-successfully.png +0 -0
- package/assets/screenshots/doc-publish.png +0 -0
- package/assets/screenshots/doc-regenerate.png +0 -0
- package/assets/screenshots/doc-translate-langs.png +0 -0
- package/assets/screenshots/doc-translate.png +0 -0
- package/assets/screenshots/doc-update.png +0 -0
- package/docs/_sidebar.md +1 -1
- package/docs/advanced-how-it-works.ja.md +31 -31
- package/docs/advanced-how-it-works.md +10 -10
- package/docs/advanced-how-it-works.zh-TW.md +24 -24
- package/docs/advanced-how-it-works.zh.md +20 -20
- package/docs/advanced-quality-assurance.ja.md +57 -61
- package/docs/advanced-quality-assurance.md +57 -61
- package/docs/advanced-quality-assurance.zh-TW.md +57 -61
- package/docs/advanced-quality-assurance.zh.md +57 -61
- package/docs/advanced.ja.md +8 -4
- package/docs/advanced.md +7 -3
- package/docs/advanced.zh-TW.md +9 -5
- package/docs/advanced.zh.md +9 -5
- package/docs/changelog.ja.md +206 -29
- package/docs/changelog.md +177 -0
- package/docs/changelog.zh-TW.md +229 -52
- package/docs/changelog.zh.md +204 -27
- package/docs/cli-reference.ja.md +181 -80
- package/docs/cli-reference.md +168 -67
- package/docs/cli-reference.zh-TW.md +177 -76
- package/docs/cli-reference.zh.md +172 -71
- package/docs/configuration-interactive-setup.ja.md +45 -42
- package/docs/configuration-interactive-setup.md +9 -6
- package/docs/configuration-interactive-setup.zh-TW.md +26 -23
- package/docs/configuration-interactive-setup.zh.md +25 -22
- package/docs/configuration-language-support.ja.md +33 -63
- package/docs/configuration-language-support.md +32 -62
- package/docs/configuration-language-support.zh-TW.md +35 -65
- package/docs/configuration-language-support.zh.md +32 -62
- package/docs/configuration-llm-setup.ja.md +25 -23
- package/docs/configuration-llm-setup.md +20 -18
- package/docs/configuration-llm-setup.zh-TW.md +21 -19
- package/docs/configuration-llm-setup.zh.md +20 -18
- package/docs/configuration-preferences.ja.md +67 -52
- package/docs/configuration-preferences.md +55 -40
- package/docs/configuration-preferences.zh-TW.md +69 -54
- package/docs/configuration-preferences.zh.md +68 -53
- package/docs/configuration.ja.md +98 -58
- package/docs/configuration.md +42 -2
- package/docs/configuration.zh-TW.md +86 -46
- package/docs/configuration.zh.md +76 -36
- package/docs/features-generate-documentation.ja.md +49 -55
- package/docs/features-generate-documentation.md +49 -55
- package/docs/features-generate-documentation.zh-TW.md +54 -60
- package/docs/features-generate-documentation.zh.md +48 -54
- package/docs/features-publish-your-docs.ja.md +68 -45
- package/docs/features-publish-your-docs.md +65 -42
- package/docs/features-publish-your-docs.zh-TW.md +74 -51
- package/docs/features-publish-your-docs.zh.md +67 -44
- package/docs/features-translate-documentation.ja.md +46 -35
- package/docs/features-translate-documentation.md +39 -28
- package/docs/features-translate-documentation.zh-TW.md +45 -34
- package/docs/features-translate-documentation.zh.md +39 -28
- package/docs/features-update-and-refine.ja.md +75 -71
- package/docs/features-update-and-refine.md +67 -63
- package/docs/features-update-and-refine.zh-TW.md +72 -67
- package/docs/features-update-and-refine.zh.md +71 -67
- package/docs/features.ja.md +29 -19
- package/docs/features.md +25 -15
- package/docs/features.zh-TW.md +28 -18
- package/docs/features.zh.md +31 -21
- package/docs/getting-started.ja.md +43 -46
- package/docs/getting-started.md +36 -39
- package/docs/getting-started.zh-TW.md +41 -44
- package/docs/getting-started.zh.md +39 -42
- package/docs/overview.ja.md +63 -11
- package/docs/overview.md +62 -10
- package/docs/overview.zh-TW.md +67 -15
- package/docs/overview.zh.md +62 -10
- package/docs-mcp/analyze-docs-relevance.yaml +6 -6
- package/docs-mcp/docs-search.yaml +1 -1
- package/media.md +9 -9
- package/package.json +2 -2
- package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
- package/prompts/common/document-structure/document-structure-rules.md +2 -2
- package/prompts/detail/custom/custom-components.md +304 -188
- package/prompts/detail/document-rules.md +5 -5
- package/prompts/detail/generate-document.md +21 -8
- package/prompts/detail/update-document.md +8 -12
- package/prompts/evaluate/document-structure.md +6 -6
- package/prompts/structure/check-document-structure.md +10 -10
- package/prompts/structure/document-rules.md +2 -2
- package/prompts/structure/generate-structure-system.md +3 -3
- package/prompts/structure/structure-example.md +1 -1
- package/prompts/structure/structure-getting-started.md +1 -1
- package/prompts/structure/update-document-structure.md +18 -14
- package/prompts/utils/feedback-refiner.md +3 -3
- package/tests/agents/clear/choose-contents.test.mjs +1 -1
- package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
- package/tests/agents/evaluate/generate-report.test.mjs +1 -1
- package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +12 -12
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
- package/tests/agents/generate/user-review-document-structure.test.mjs +36 -13
- package/tests/agents/update/check-document.test.mjs +1 -1
- package/tests/agents/update/document-tools/update-document-content.test.mjs +115 -112
- package/tests/agents/update/fs-tools/glob.test.mjs +438 -0
- package/tests/agents/update/fs-tools/grep.test.mjs +279 -0
- package/tests/agents/update/fs-tools/read-file.test.mjs +553 -0
- package/tests/agents/update/user-review-document.test.mjs +48 -27
- package/tests/agents/utils/format-document-structure.test.mjs +5 -5
- package/tests/agents/utils/load-sources.test.mjs +4 -4
- package/tests/agents/utils/save-docs.test.mjs +1 -1
- package/tests/utils/conflict-detector.test.mjs +1 -1
- package/tests/utils/docs-finder-utils.test.mjs +8 -8
- package/types/document-schema.mjs +5 -6
- package/types/document-structure-schema.mjs +25 -13
- package/utils/conflict-detector.mjs +1 -1
- package/utils/constants/index.mjs +4 -4
- package/utils/docs-finder-utils.mjs +11 -11
- package/utils/markdown-checker.mjs +1 -1
package/docs/configuration.ja.md
CHANGED
|
@@ -1,22 +1,62 @@
|
|
|
1
1
|
# 設定ガイド
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith の動作は、中央設定ファイル `.aigne/doc-smith/config.yaml` によって制御されます。このファイルを使用して、ドキュメントのスタイル、対象読者、言語、構造を特定のニーズに合わせてカスタマイズできます。
|
|
4
4
|
|
|
5
|
-
`aigne doc init
|
|
5
|
+
`aigne doc init` を実行して、対話式のセットアップウィザードを使用してこのファイルを作成および管理できます。手順ごとのウォークスルーについては、[対話式セットアップ](./configuration-interactive-setup.md)ガイドを参照してください。または、ファイルを直接編集して、より詳細な制御を行うこともできます。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
以下の図は、設定のワークフローを示しています。
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
```d2 設定ワークフロー
|
|
10
|
+
direction: down
|
|
11
|
+
|
|
12
|
+
User: {
|
|
13
|
+
shape: person
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
CLI: {
|
|
17
|
+
label: "コマンド実行\n'aigne doc init'"
|
|
18
|
+
shape: rectangle
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
Setup-Wizard: {
|
|
22
|
+
label: "対話式セットアップウィザード"
|
|
23
|
+
shape: rectangle
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
Config-File: {
|
|
27
|
+
label: ".aigne/doc-smith/config.yaml"
|
|
28
|
+
shape: rectangle
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
AIGNE-DocSmith-Engine: {
|
|
32
|
+
label: "AIGNE DocSmith エンジン"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
# パス1: 対話式セットアップ (推奨)
|
|
36
|
+
User -> CLI: "推奨パス"
|
|
37
|
+
CLI -> Setup-Wizard: "起動"
|
|
38
|
+
Setup-Wizard -> Config-File: "作成 / 変更"
|
|
39
|
+
|
|
40
|
+
# パス2: 手動編集
|
|
41
|
+
User -> Config-File: "代替パス:\n直接編集"
|
|
42
|
+
|
|
43
|
+
# 最終ステップ
|
|
44
|
+
Config-File -> AIGNE-DocSmith-Engine: "設定"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## 主要な設定領域
|
|
48
|
+
|
|
49
|
+
ドキュメントは、いくつかの主要な設定領域によって形成されます。これらのガイドを参照して、生成プロセスの各側面を微調整する方法を理解してください。
|
|
10
50
|
|
|
11
51
|
<x-cards data-columns="2">
|
|
12
52
|
<x-card data-title="対話式セットアップ" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
|
|
13
|
-
|
|
53
|
+
推奨設定や競合検出を含む、ドキュメントプロジェクトの設定を支援するガイド付きウィザードについて学びます。
|
|
14
54
|
</x-card>
|
|
15
|
-
<x-card data-title="LLMセットアップ" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
|
|
16
|
-
API
|
|
55
|
+
<x-card data-title="LLM セットアップ" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
|
|
56
|
+
APIキーが不要な組み込みのAIGNEハブの使用を含む、さまざまなAIモデルの接続方法を発見します。
|
|
17
57
|
</x-card>
|
|
18
58
|
<x-card data-title="言語サポート" data-icon="lucide:languages" data-href="/configuration/language-support">
|
|
19
|
-
|
|
59
|
+
サポートされている言語の全リストを確認し、主要言語の設定方法や自動翻訳の有効化方法を学びます。
|
|
20
60
|
</x-card>
|
|
21
61
|
<x-card data-title="設定の管理" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
|
|
22
62
|
DocSmithがフィードバックを使用して永続的なルールを作成する方法と、CLIを介してそれらを管理する方法を理解します。
|
|
@@ -25,130 +65,130 @@ AIGNE DocSmithの動作は、`.aigne/doc-smith/config.yaml`に配置されてい
|
|
|
25
65
|
|
|
26
66
|
## パラメータリファレンス
|
|
27
67
|
|
|
28
|
-
`config.yaml
|
|
68
|
+
`config.yaml` ファイルには、ドキュメントの出力を制御するいくつかのキーと値のペアが含まれています。以下は、各パラメータの詳細なリファレンスです。
|
|
29
69
|
|
|
30
70
|
### プロジェクト情報
|
|
31
71
|
|
|
32
72
|
これらの設定は、プロジェクトに関する基本的なコンテキストを提供し、ドキュメントを公開する際に使用されます。
|
|
33
73
|
|
|
34
|
-
|
|
|
74
|
+
| パラメータ | 説明 |
|
|
35
75
|
|---|---|
|
|
36
|
-
| `projectName` | プロジェクトの名前。`package.json
|
|
37
|
-
| `projectDesc` | プロジェクトの短い説明。`package.json
|
|
38
|
-
| `projectLogo` | プロジェクトのロゴ画像へのパスまたはURL。 |
|
|
76
|
+
| `projectName` | プロジェクトの名前。`package.json` があればそこから検出されます。 |
|
|
77
|
+
| `projectDesc` | プロジェクトの短い説明。`package.json` から検出されます。 |
|
|
78
|
+
| `projectLogo` | プロジェクトのロゴ画像へのパスまたは URL。 |
|
|
39
79
|
|
|
40
80
|
### ドキュメンテーション戦略
|
|
41
81
|
|
|
42
82
|
これらのパラメータは、生成されるコンテンツのトーン、スタイル、深さを定義します。
|
|
43
83
|
|
|
44
84
|
#### `documentPurpose`
|
|
45
|
-
|
|
85
|
+
読者に達成してもらいたい主な成果を定義します。この設定は、ドキュメントの全体的な構造と焦点に影響を与えます。
|
|
46
86
|
|
|
47
|
-
|
|
|
87
|
+
| オプション | 名前 | 説明 |
|
|
48
88
|
|---|---|---|
|
|
49
|
-
| `getStarted` |
|
|
89
|
+
| `getStarted` | 迅速な開始 | 新規ユーザーが30分未満でゼロから作業を開始できるように支援します。 |
|
|
50
90
|
| `completeTasks` | 特定のタスクを完了する | 一般的なワークフローとユースケースを通じてユーザーをガイドします。 |
|
|
51
|
-
| `findAnswers` |
|
|
52
|
-
| `understandSystem`| システムを理解する |
|
|
53
|
-
| `solveProblems` |
|
|
91
|
+
| `findAnswers` | 迅速に答えを見つける | すべての機能とAPIの検索可能なリファレンスを提供します。 |
|
|
92
|
+
| `understandSystem`| システムを理解する | それがどのように機能し、なぜ設計上の決定がなされたかを説明します。 |
|
|
93
|
+
| `solveProblems` | 一般的な問題のトラブルシューティング | ユーザーが問題をトラブルシューティングし、修正するのを助けます。 |
|
|
54
94
|
| `mixedPurpose` | 複数の目的を果たす | 複数のニーズをカバーするドキュメント。 |
|
|
55
95
|
|
|
56
96
|
#### `targetAudienceTypes`
|
|
57
|
-
|
|
97
|
+
このドキュメントを最も頻繁に読むであろう人物を定義します。この選択は、ライティングスタイルと例に影響を与えます。
|
|
58
98
|
|
|
59
|
-
|
|
|
99
|
+
| オプション | 名前 | 説明 |
|
|
60
100
|
|---|---|---|
|
|
61
101
|
| `endUsers` | エンドユーザー(非技術者) | 製品を使用するがコーディングはしない人々。 |
|
|
62
|
-
| `developers` | 製品/APIを統合する開発者 |
|
|
63
|
-
| `devops` | DevOps / SRE / インフラストラクチャチーム |
|
|
102
|
+
| `developers` | 製品/APIを統合する開発者 | これを自分のプロジェクトに追加するエンジニア。 |
|
|
103
|
+
| `devops` | DevOps / SRE / インフラストラクチャチーム | システムの展開、監視、保守を行うチーム。 |
|
|
64
104
|
| `decisionMakers`| 技術的な意思決定者 | 実装を評価または計画するアーキテクトやリード。 |
|
|
65
|
-
| `supportTeams` | サポートチーム |
|
|
66
|
-
| `mixedTechnical`|
|
|
105
|
+
| `supportTeams` | サポートチーム | 他の人が製品を使用するのを助ける人々。 |
|
|
106
|
+
| `mixedTechnical`| 混合技術オーディエンス | 開発者、DevOps、その他の技術ユーザー。 |
|
|
67
107
|
|
|
68
108
|
#### `readerKnowledgeLevel`
|
|
69
|
-
|
|
109
|
+
読者が通常、到着時に何を知っているかを定義します。これにより、どれだけの基礎知識が前提とされるかが調整されます。
|
|
70
110
|
|
|
71
|
-
|
|
|
111
|
+
| オプション | 名前 | 説明 |
|
|
72
112
|
|---|---|---|
|
|
73
|
-
| `completeBeginners` |
|
|
74
|
-
| `domainFamiliar` | 以前に類似のツールを使用したことがある |
|
|
113
|
+
| `completeBeginners` | 完全な初心者で、ゼロから始める | このドメイン/テクノロジーに全く新しい。 |
|
|
114
|
+
| `domainFamiliar` | 以前に類似のツールを使用したことがある | 問題領域は知っているが、この特定の解決策には新しい。 |
|
|
75
115
|
| `experiencedUsers` | 特定のことをしようとしている専門家 | リファレンスや高度なトピックを必要とする通常のユーザー。 |
|
|
76
116
|
| `emergencyTroubleshooting`| 緊急/トラブルシューティング | 何かが壊れており、迅速に修正する必要がある。 |
|
|
77
|
-
| `exploringEvaluating` |
|
|
117
|
+
| `exploringEvaluating` | このツールを他と比較評価している | これが自分のニーズに合うかどうかを理解しようとしている。 |
|
|
78
118
|
|
|
79
119
|
#### `documentationDepth`
|
|
80
120
|
ドキュメントがどれだけ包括的であるべきかを定義します。
|
|
81
121
|
|
|
82
|
-
|
|
|
122
|
+
| オプション | 名前 | 説明 |
|
|
83
123
|
|---|---|---|
|
|
84
|
-
| `essentialOnly` |
|
|
85
|
-
| `balancedCoverage`| バランスの取れたカバレッジ |
|
|
86
|
-
| `comprehensive` | 包括的 |
|
|
124
|
+
| `essentialOnly` | 不可欠なもののみ | 80%のユースケースをカバーし、簡潔に保ちます。 |
|
|
125
|
+
| `balancedCoverage`| バランスの取れたカバレッジ | 実用的な例を含む適切な深さ [推奨]。 |
|
|
126
|
+
| `comprehensive` | 包括的 | すべての機能、エッジケース、高度なシナリオをカバーします。 |
|
|
87
127
|
| `aiDecide` | AIに決定させる | コードの複雑さを分析し、適切な深さを提案します。 |
|
|
88
128
|
|
|
89
129
|
### カスタムディレクティブ
|
|
90
130
|
|
|
91
|
-
|
|
131
|
+
より詳細な制御のために、自由形式の指示を提供できます。
|
|
92
132
|
|
|
93
|
-
|
|
|
133
|
+
| パラメータ | 説明 |
|
|
94
134
|
|---|---|
|
|
95
|
-
| `rules` |
|
|
96
|
-
| `targetAudience`|
|
|
135
|
+
| `rules` | 特定のドキュメント生成ルール(例:「常にパフォーマンスベンチマークを含める」)を定義できる複数行の文字列。 |
|
|
136
|
+
| `targetAudience`| プリセットで許容されるよりも詳細に特定のターゲットオーディエンスを記述するための複数行の文字列。 |
|
|
97
137
|
|
|
98
138
|
### 言語とパスの設定
|
|
99
139
|
|
|
100
|
-
|
|
140
|
+
これらの設定は、ローカライゼーションとファイルの場所を制御します。
|
|
101
141
|
|
|
102
|
-
|
|
|
142
|
+
| パラメータ | 説明 |
|
|
103
143
|
|---|---|
|
|
104
144
|
| `locale` | ドキュメントの主要言語(例:`en`、`zh`)。 |
|
|
105
145
|
| `translateLanguages` | ドキュメントを翻訳する言語コードのリスト(例:`[ja, fr, es]`)。 |
|
|
106
146
|
| `docsDir` | 生成されたドキュメントファイルが保存されるディレクトリ。 |
|
|
107
|
-
| `sourcesPath` | DocSmith
|
|
147
|
+
| `sourcesPath` | DocSmithが分析するソースコードのパスまたはグロブパターンのリスト(例:`['./src', './lib/**/*.js']`)。 |
|
|
108
148
|
| `glossary` | 一貫した翻訳を保証するために、プロジェクト固有の用語を含むマークダウンファイル(`@glossary.md`)へのパス。 |
|
|
109
149
|
|
|
110
|
-
## config.yamlの例
|
|
150
|
+
## config.yaml の例
|
|
111
151
|
|
|
112
152
|
以下は、完全な設定ファイルの例です。このファイルを直接編集して、いつでも設定を変更できます。
|
|
113
153
|
|
|
114
|
-
```yaml
|
|
154
|
+
```yaml config.yaml の例 icon=logos:yaml
|
|
115
155
|
# ドキュメント公開のためのプロジェクト情報
|
|
116
156
|
projectName: AIGNE DocSmith
|
|
117
|
-
projectDesc: AI
|
|
157
|
+
projectDesc: AI駆動のドキュメント生成ツール。
|
|
118
158
|
projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
|
|
119
159
|
|
|
120
160
|
# =============================================================================
|
|
121
|
-
#
|
|
161
|
+
# ドキュメント設定
|
|
122
162
|
# =============================================================================
|
|
123
163
|
|
|
124
|
-
#
|
|
125
|
-
#
|
|
164
|
+
# 目的: 読者に達成してもらいたい主な成果は何か?
|
|
165
|
+
# オプション: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
|
|
126
166
|
documentPurpose:
|
|
127
167
|
- completeTasks
|
|
128
168
|
- findAnswers
|
|
129
169
|
|
|
130
|
-
#
|
|
131
|
-
#
|
|
170
|
+
# 対象読者: これを最も頻繁に読むのは誰か?
|
|
171
|
+
# オプション: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
|
|
132
172
|
targetAudienceTypes:
|
|
133
173
|
- developers
|
|
134
174
|
|
|
135
|
-
#
|
|
136
|
-
#
|
|
175
|
+
# 読者の知識レベル: 読者は通常、到着時に何を知っているか?
|
|
176
|
+
# オプション: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
|
|
137
177
|
readerKnowledgeLevel: domainFamiliar
|
|
138
178
|
|
|
139
|
-
#
|
|
140
|
-
#
|
|
179
|
+
# ドキュメントの深さ: ドキュメントはどれだけ包括的であるべきか?
|
|
180
|
+
# オプション: essentialOnly, balancedCoverage, comprehensive, aiDecide
|
|
141
181
|
documentationDepth: balancedCoverage
|
|
142
182
|
|
|
143
|
-
#
|
|
183
|
+
# カスタムルール: 特定のドキュメント生成ルールと要件を定義します
|
|
144
184
|
rules: |+
|
|
145
185
|
|
|
146
186
|
|
|
147
|
-
#
|
|
187
|
+
# 対象読者: 特定の対象読者とその特徴を記述します
|
|
148
188
|
targetAudience: |+
|
|
149
189
|
|
|
150
190
|
|
|
151
|
-
#
|
|
191
|
+
# 用語集: プロジェクト固有の用語と定義を含むマークダウンファイルへのパス
|
|
152
192
|
# glossary: "@glossary.md"
|
|
153
193
|
|
|
154
194
|
# ドキュメントの主要言語
|
|
@@ -162,11 +202,11 @@ locale: en
|
|
|
162
202
|
# 生成されたドキュメントを保存するディレクトリ
|
|
163
203
|
docsDir: .aigne/doc-smith/docs
|
|
164
204
|
|
|
165
|
-
#
|
|
205
|
+
# 分析するソースコードのパス
|
|
166
206
|
sourcesPath:
|
|
167
207
|
- ./
|
|
168
208
|
```
|
|
169
209
|
|
|
170
|
-
|
|
210
|
+
設定が完了したら、プロジェクトのニーズに合ったドキュメントを作成する準備ができました。次のステップは、生成コマンドを実行することです。
|
|
171
211
|
|
|
172
212
|
➡️ **次へ:** [ドキュメントの生成](./features-generate-documentation.md)
|
package/docs/configuration.md
CHANGED
|
@@ -1,8 +1,48 @@
|
|
|
1
1
|
# Configuration Guide
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith's behavior is controlled by a central file,
|
|
3
|
+
AIGNE DocSmith's behavior is controlled by a central configuration file, `.aigne/doc-smith/config.yaml`. This file allows you to customize the style, target audience, languages, and structure of your documentation to meet your specific needs.
|
|
4
4
|
|
|
5
|
-
You can create and manage this file using the interactive setup wizard by running `aigne doc init`. For a step-by-step walkthrough,
|
|
5
|
+
You can create and manage this file using the interactive setup wizard by running `aigne doc init`. For a step-by-step walkthrough, please refer to the [Interactive Setup](./configuration-interactive-setup.md) guide. Alternatively, you can edit the file directly for more granular control.
|
|
6
|
+
|
|
7
|
+
The following diagram illustrates the configuration workflow:
|
|
8
|
+
|
|
9
|
+
```d2 Configuration Workflow
|
|
10
|
+
direction: down
|
|
11
|
+
|
|
12
|
+
User: {
|
|
13
|
+
shape: person
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
CLI: {
|
|
17
|
+
label: "Run Command\n'aigne doc init'"
|
|
18
|
+
shape: rectangle
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
Setup-Wizard: {
|
|
22
|
+
label: "Interactive Setup Wizard"
|
|
23
|
+
shape: rectangle
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
Config-File: {
|
|
27
|
+
label: ".aigne/doc-smith/config.yaml"
|
|
28
|
+
shape: rectangle
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
AIGNE-DocSmith-Engine: {
|
|
32
|
+
label: "AIGNE DocSmith Engine"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
# Path 1: Interactive Setup (Recommended)
|
|
36
|
+
User -> CLI: "Recommended Path"
|
|
37
|
+
CLI -> Setup-Wizard: "Launches"
|
|
38
|
+
Setup-Wizard -> Config-File: "Creates / Modifies"
|
|
39
|
+
|
|
40
|
+
# Path 2: Manual Editing
|
|
41
|
+
User -> Config-File: "Alternative Path:\nDirectly Edits"
|
|
42
|
+
|
|
43
|
+
# Final Step
|
|
44
|
+
Config-File -> AIGNE-DocSmith-Engine: "Configures"
|
|
45
|
+
```
|
|
6
46
|
|
|
7
47
|
## Core Configuration Areas
|
|
8
48
|
|
|
@@ -1,25 +1,65 @@
|
|
|
1
1
|
# 設定指南
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 的行為由一個中央設定檔 `.aigne/doc-smith/config.yaml` 控制。此檔案可讓您自訂文件的風格、目標受眾、語言和結構,以滿足您的特定需求。
|
|
4
4
|
|
|
5
|
-
您可以透過執行 `aigne doc init
|
|
5
|
+
您可以透過執行 `aigne doc init`,使用互動式設定精靈來建立和管理此檔案。如需逐步說明,請參閱 [互動式設定](./configuration-interactive-setup.md) 指南。或者,您也可以直接編輯檔案以進行更精細的控制。
|
|
6
|
+
|
|
7
|
+
下圖說明了設定工作流程:
|
|
8
|
+
|
|
9
|
+
```d2 設定工作流程
|
|
10
|
+
direction: down
|
|
11
|
+
|
|
12
|
+
User: {
|
|
13
|
+
shape: person
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
CLI: {
|
|
17
|
+
label: "執行命令\n'aigne doc init'"
|
|
18
|
+
shape: rectangle
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
Setup-Wizard: {
|
|
22
|
+
label: "互動式設定精靈"
|
|
23
|
+
shape: rectangle
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
Config-File: {
|
|
27
|
+
label: ".aigne/doc-smith/config.yaml"
|
|
28
|
+
shape: rectangle
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
AIGNE-DocSmith-Engine: {
|
|
32
|
+
label: "AIGNE DocSmith 引擎"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
# 路徑 1:互動式設定(建議)
|
|
36
|
+
User -> CLI: "建議路徑"
|
|
37
|
+
CLI -> Setup-Wizard: "啟動"
|
|
38
|
+
Setup-Wizard -> Config-File: "建立/修改"
|
|
39
|
+
|
|
40
|
+
# 路徑 2:手動編輯
|
|
41
|
+
User -> Config-File: "替代路徑:\n直接編輯"
|
|
42
|
+
|
|
43
|
+
# 最後一步
|
|
44
|
+
Config-File -> AIGNE-DocSmith-Engine: "設定"
|
|
45
|
+
```
|
|
6
46
|
|
|
7
47
|
## 核心設定區域
|
|
8
48
|
|
|
9
|
-
|
|
49
|
+
您的文件由幾個關鍵的設定區域構成。請探索這些指南,以了解如何微調生成過程的各個方面。
|
|
10
50
|
|
|
11
51
|
<x-cards data-columns="2">
|
|
12
52
|
<x-card data-title="互動式設定" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
|
|
13
53
|
了解引導式精靈如何幫助您設定文件專案,包括設定建議和衝突偵測。
|
|
14
54
|
</x-card>
|
|
15
55
|
<x-card data-title="LLM 設定" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
|
|
16
|
-
探索如何連接不同的 AI 模型,包括使用內建的 AIGNE Hub
|
|
56
|
+
探索如何連接不同的 AI 模型,包括使用內建的 AIGNE Hub,無需 API 金鑰。
|
|
17
57
|
</x-card>
|
|
18
58
|
<x-card data-title="語言支援" data-icon="lucide:languages" data-href="/configuration/language-support">
|
|
19
59
|
查看支援的語言完整列表,並了解如何設定主要語言和啟用自動翻譯。
|
|
20
60
|
</x-card>
|
|
21
61
|
<x-card data-title="管理偏好設定" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
|
|
22
|
-
了解 DocSmith
|
|
62
|
+
了解 DocSmith 如何使用您的回饋來建立持續性規則,以及如何透過 CLI 管理它們。
|
|
23
63
|
</x-card>
|
|
24
64
|
</x-cards>
|
|
25
65
|
|
|
@@ -29,99 +69,99 @@ AIGNE DocSmith 的行為由一個中央檔案控制,即位於 `.aigne/doc-smit
|
|
|
29
69
|
|
|
30
70
|
### 專案資訊
|
|
31
71
|
|
|
32
|
-
|
|
72
|
+
這些設定提供了關於您專案的基本情境,用於發布文件。
|
|
33
73
|
|
|
34
|
-
|
|
|
74
|
+
| Parameter | Description |
|
|
35
75
|
|---|---|
|
|
36
|
-
| `projectName` | 您的專案名稱。如果 `package.json`
|
|
76
|
+
| `projectName` | 您的專案名稱。如果 `package.json` 存在,則會從中偵測。 |
|
|
37
77
|
| `projectDesc` | 您的專案簡短描述。從 `package.json` 偵測。 |
|
|
38
|
-
| `projectLogo` |
|
|
78
|
+
| `projectLogo` | 您專案標誌圖片的路徑或 URL。 |
|
|
39
79
|
|
|
40
80
|
### 文件策略
|
|
41
81
|
|
|
42
82
|
這些參數定義了生成內容的語氣、風格和深度。
|
|
43
83
|
|
|
44
84
|
#### `documentPurpose`
|
|
45
|
-
|
|
85
|
+
定義您希望讀者達成的最主要成果。此設定會影響文件的整體結構和重點。
|
|
46
86
|
|
|
47
|
-
|
|
|
87
|
+
| Option | Name | Description |
|
|
48
88
|
|---|---|---|
|
|
49
|
-
| `getStarted` | 快速入門 | 幫助新使用者在 30
|
|
89
|
+
| `getStarted` | 快速入門 | 幫助新使用者在 <30 分鐘內從零到上手。 |
|
|
50
90
|
| `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
|
|
51
|
-
| `findAnswers` |
|
|
91
|
+
| `findAnswers` | 快速尋找答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
|
|
52
92
|
| `understandSystem`| 了解系統 | 解釋其運作方式以及設計決策的原因。 |
|
|
53
|
-
| `solveProblems` | 解決常見問題 |
|
|
93
|
+
| `solveProblems` | 解決常見問題 | 幫助使用者排除故障並修復問題。 |
|
|
54
94
|
| `mixedPurpose` | 服務多種目的 | 涵蓋多種需求的文件。 |
|
|
55
95
|
|
|
56
96
|
#### `targetAudienceTypes`
|
|
57
97
|
定義最常閱讀此文件的對象。此選擇會影響寫作風格和範例。
|
|
58
98
|
|
|
59
|
-
|
|
|
99
|
+
| Option | Name | Description |
|
|
60
100
|
|---|---|---|
|
|
61
|
-
| `endUsers` | 終端使用者(非技術人員) |
|
|
62
|
-
| `developers` |
|
|
63
|
-
| `devops` | DevOps / SRE /
|
|
101
|
+
| `endUsers` | 終端使用者(非技術人員) | 使用產品但不編寫程式的人員。 |
|
|
102
|
+
| `developers` | 整合您產品/API 的開發人員 | 將此產品加入其專案的工程師。 |
|
|
103
|
+
| `devops` | DevOps / SRE / 基礎架構團隊 | 部署、監控和維護系統的團隊。 |
|
|
64
104
|
| `decisionMakers`| 技術決策者 | 評估或規劃實施的架構師或主管。 |
|
|
65
105
|
| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
|
|
66
106
|
| `mixedTechnical`| 混合技術受眾 | 開發人員、DevOps 和其他技術使用者。 |
|
|
67
107
|
|
|
68
108
|
#### `readerKnowledgeLevel`
|
|
69
|
-
|
|
109
|
+
定義讀者通常具備的知識水平。這會調整文件中假設的基礎知識多寡。
|
|
70
110
|
|
|
71
|
-
|
|
|
111
|
+
| Option | Name | Description |
|
|
72
112
|
|---|---|---|
|
|
73
|
-
| `completeBeginners` |
|
|
74
|
-
| `domainFamiliar` |
|
|
75
|
-
| `experiencedUsers` |
|
|
113
|
+
| `completeBeginners` | 完全的初學者,從零開始 | 對此領域/技術完全陌生。 |
|
|
114
|
+
| `domainFamiliar` | 曾使用過類似工具 | 了解問題領域,但對此特定解決方案不熟悉。 |
|
|
115
|
+
| `experiencedUsers` | 是專家,想做特定的事情 | 需要參考資料或進階主題的常規使用者。 |
|
|
76
116
|
| `emergencyTroubleshooting`| 緊急/故障排除 | 有東西壞了,需要快速修復。 |
|
|
77
|
-
| `exploringEvaluating` |
|
|
117
|
+
| `exploringEvaluating` | 正在評估此工具與其他工具的比較 | 試圖了解此工具是否符合他們的需求。 |
|
|
78
118
|
|
|
79
119
|
#### `documentationDepth`
|
|
80
120
|
定義文件的全面程度。
|
|
81
121
|
|
|
82
|
-
|
|
|
122
|
+
| Option | Name | Description |
|
|
83
123
|
|---|---|---|
|
|
84
|
-
| `essentialOnly` |
|
|
85
|
-
| `balancedCoverage`|
|
|
86
|
-
| `comprehensive` |
|
|
87
|
-
| `aiDecide` | 讓 AI 決定 |
|
|
124
|
+
| `essentialOnly` | 僅限必要內容 | 涵蓋 80% 的使用案例,保持簡潔。 |
|
|
125
|
+
| `balancedCoverage`| 均衡涵蓋 | 具備良好深度和實用範例 [建議]。 |
|
|
126
|
+
| `comprehensive` | 全面詳盡 | 涵蓋所有功能、邊界案例和進階情境。 |
|
|
127
|
+
| `aiDecide` | 讓 AI 決定 | 分析程式碼複雜度並建議適當的深度。 |
|
|
88
128
|
|
|
89
129
|
### 自訂指令
|
|
90
130
|
|
|
91
|
-
|
|
131
|
+
若要進行更精細的控制,您可以提供自由文字的指令。
|
|
92
132
|
|
|
93
|
-
|
|
|
133
|
+
| Parameter | Description |
|
|
94
134
|
|---|---|
|
|
95
|
-
| `rules` |
|
|
135
|
+
| `rules` | 一個多行字串,您可以在其中定義特定的文件生成規則(例如,「務必包含效能基準測試」)。 |
|
|
96
136
|
| `targetAudience`| 一個多行字串,用以比預設選項更詳細地描述您的特定目標受眾。 |
|
|
97
137
|
|
|
98
138
|
### 語言與路徑設定
|
|
99
139
|
|
|
100
140
|
這些設定控制本地化和檔案位置。
|
|
101
141
|
|
|
102
|
-
|
|
|
142
|
+
| Parameter | Description |
|
|
103
143
|
|---|---|
|
|
104
|
-
| `locale` |
|
|
105
|
-
| `translateLanguages` |
|
|
106
|
-
| `docsDir` |
|
|
107
|
-
| `sourcesPath` | 供 DocSmith 分析的原始碼路徑或 glob
|
|
108
|
-
| `glossary` |
|
|
144
|
+
| `locale` | 文件的主要語言(例如 `en`、`zh`)。 |
|
|
145
|
+
| `translateLanguages` | 要將文件翻譯成的語言代碼列表(例如 `[ja, fr, es]`)。 |
|
|
146
|
+
| `docsDir` | 儲存生成文件檔案的目錄。 |
|
|
147
|
+
| `sourcesPath` | 供 DocSmith 分析的原始碼路徑或 glob 模式列表(例如 `['./src', './lib/**/*.js']`)。 |
|
|
148
|
+
| `glossary` | 指向一個 markdown 檔案(`@glossary.md`)的路徑,該檔案包含專案特定術語以確保翻譯的一致性。 |
|
|
109
149
|
|
|
110
150
|
## config.yaml 範例
|
|
111
151
|
|
|
112
|
-
|
|
152
|
+
這是一個完整的設定檔範例。您可以隨時直接編輯此檔案以更改設定。
|
|
113
153
|
|
|
114
|
-
```yaml
|
|
115
|
-
#
|
|
154
|
+
```yaml config.yaml 範例 icon=logos:yaml
|
|
155
|
+
# 文件發布的專案資訊
|
|
116
156
|
projectName: AIGNE DocSmith
|
|
117
|
-
projectDesc:
|
|
157
|
+
projectDesc: An AI-driven documentation generation tool.
|
|
118
158
|
projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
|
|
119
159
|
|
|
120
160
|
# =============================================================================
|
|
121
161
|
# 文件設定
|
|
122
162
|
# =============================================================================
|
|
123
163
|
|
|
124
|
-
#
|
|
164
|
+
# 目的:您希望讀者達成的最主要成果是什麼?
|
|
125
165
|
# 選項:getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
|
|
126
166
|
documentPurpose:
|
|
127
167
|
- completeTasks
|
|
@@ -132,7 +172,7 @@ documentPurpose:
|
|
|
132
172
|
targetAudienceTypes:
|
|
133
173
|
- developers
|
|
134
174
|
|
|
135
|
-
#
|
|
175
|
+
# 讀者知識水平:讀者通常具備什麼知識?
|
|
136
176
|
# 選項:completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
|
|
137
177
|
readerKnowledgeLevel: domainFamiliar
|
|
138
178
|
|
|
@@ -167,6 +207,6 @@ sourcesPath:
|
|
|
167
207
|
- ./
|
|
168
208
|
```
|
|
169
209
|
|
|
170
|
-
|
|
210
|
+
完成設定後,您就可以開始建立符合專案需求的文件了。下一步是執行生成命令。
|
|
171
211
|
|
|
172
|
-
➡️ **下一步:** [
|
|
212
|
+
➡️ **下一步:** [產生文件](./features-generate-documentation.md)
|