@aigne/doc-smith 0.8.11-beta.6 → 0.8.11
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 +2 -0
- 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 +20 -0
- package/README.md +1 -1
- package/agents/generate/document-structure-tools/add-document.mjs +35 -10
- package/agents/generate/document-structure-tools/delete-document.mjs +35 -12
- package/agents/generate/document-structure-tools/move-document.mjs +43 -17
- package/agents/generate/document-structure-tools/update-document.mjs +37 -10
- package/agents/generate/update-document-structure.yaml +1 -7
- package/agents/generate/user-review-document-structure.mjs +5 -4
- package/agents/translate/translate-document.yaml +1 -9
- 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/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/advanced-how-it-works.ja.md +31 -31
- package/docs/advanced-how-it-works.md +9 -9
- 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 +82 -52
- package/docs/cli-reference.md +56 -26
- package/docs/cli-reference.zh-TW.md +82 -52
- package/docs/cli-reference.zh.md +70 -40
- package/docs/configuration-interactive-setup.ja.md +45 -42
- package/docs/configuration-interactive-setup.md +8 -5
- 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 +56 -41
- package/docs/configuration-preferences.zh-TW.md +69 -54
- package/docs/configuration-preferences.zh.md +68 -53
- package/docs/configuration.ja.md +65 -81
- package/docs/configuration.md +19 -35
- package/docs/configuration.zh-TW.md +62 -79
- package/docs/configuration.zh.md +50 -67
- package/docs/features-generate-documentation.ja.md +44 -69
- package/docs/features-generate-documentation.md +36 -61
- package/docs/features-generate-documentation.zh-TW.md +42 -67
- package/docs/features-generate-documentation.zh.md +41 -67
- package/docs/features-publish-your-docs.ja.md +36 -36
- package/docs/features-publish-your-docs.md +2 -2
- package/docs/features-publish-your-docs.zh-TW.md +21 -21
- package/docs/features-publish-your-docs.zh.md +23 -23
- package/docs/features-translate-documentation.ja.md +40 -31
- package/docs/features-translate-documentation.md +15 -6
- package/docs/features-translate-documentation.zh-TW.md +37 -28
- package/docs/features-translate-documentation.zh.md +23 -14
- package/docs/features-update-and-refine.ja.md +68 -118
- package/docs/features-update-and-refine.md +58 -108
- package/docs/features-update-and-refine.zh-TW.md +67 -116
- package/docs/features-update-and-refine.zh.md +64 -114
- 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 +40 -43
- package/docs/getting-started.md +36 -39
- package/docs/getting-started.zh-TW.md +38 -41
- package/docs/getting-started.zh.md +45 -48
- package/docs/overview.ja.md +63 -11
- package/docs/overview.md +60 -8
- package/docs/overview.zh-TW.md +67 -15
- package/docs/overview.zh.md +62 -10
- package/media.md +9 -9
- package/package.json +1 -1
- package/prompts/detail/custom/custom-components.md +304 -188
- package/prompts/detail/document-rules.md +4 -4
- package/prompts/detail/generate-document.md +21 -8
- package/prompts/detail/update-document.md +8 -12
- package/prompts/structure/update-document-structure.md +12 -8
- package/prompts/utils/feedback-refiner.md +3 -3
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +9 -9
- package/tests/agents/generate/user-review-document-structure.test.mjs +29 -8
- 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/types/document-schema.mjs +5 -6
- package/types/document-structure-schema.mjs +20 -8
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# インタラクティブなセットアップ
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmithには、`aigne doc init`コマンドで起動するインタラクティブなセットアップウィザードが含まれており、プロジェクトの設定を効率化します。このガイド付きプロセスでは、ドキュメントの目標に関する一連の質問が行われ、回答に基づいて`config.yaml`ファイルが生成されます。設定エラーを防ぎ、入力に基づいて具体的な推奨事項を提供するため、新しいドキュメントプロジェクトを開始する際に推奨される方法です。
|
|
4
4
|
|
|
5
5
|
## ウィザードの実行
|
|
6
6
|
|
|
@@ -10,22 +10,22 @@ AIGNE DocSmithには、プロジェクト設定を効率化するための対話
|
|
|
10
10
|
npx aigne doc init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
ウィザードが8つのステップでドキュメントの設定を案内します。
|
|
14
14
|
|
|
15
15
|
## ガイド付きプロセス
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
ウィザードでは、以下の主要な設定項目についてプロンプトが表示されます。
|
|
18
18
|
|
|
19
|
-
1.
|
|
20
|
-
2.
|
|
21
|
-
3. **読者の知識レベル**:
|
|
19
|
+
1. **プライマリゴール**: 読者の主な目的を定義します(例:利用開始、回答の検索)。
|
|
20
|
+
2. **ターゲットオーディエンス**: ドキュメントの主な読者を指定します(例:非技術系のエンドユーザー、開発者)。
|
|
21
|
+
3. **読者の知識レベル**: 読者の一般的な初期知識を評価します。
|
|
22
22
|
4. **ドキュメントの深さ**: コンテンツの詳細レベルと範囲を決定します。
|
|
23
|
-
5.
|
|
24
|
-
6. **翻訳言語**:
|
|
23
|
+
5. **プライマリ言語**: ドキュメントの主要言語を設定します。
|
|
24
|
+
6. **翻訳言語**: 翻訳用の追加言語を選択します。
|
|
25
25
|
7. **出力ディレクトリ**: 生成されたドキュメントファイルの場所を指定します。
|
|
26
|
-
8.
|
|
26
|
+
8. **ソースコードパス**: globパターンをサポートし、分析するファイルとディレクトリを定義します。
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## アシスト付き設定
|
|
29
29
|
|
|
30
30
|
ウィザードは、一貫性のある効果的な設定を作成するために、事前定義された一連のルールを使用します。
|
|
31
31
|
|
|
@@ -33,87 +33,86 @@ npx aigne doc init
|
|
|
33
33
|
direction: down
|
|
34
34
|
|
|
35
35
|
User-Selections: {
|
|
36
|
-
label: "1.
|
|
36
|
+
label: "1. ユーザーが入力\n(目的、オーディエンスなど)"
|
|
37
37
|
shape: rectangle
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
Wizard-Engine: {
|
|
41
|
-
label: "2.
|
|
41
|
+
label: "2. ウィザードのルールエンジン"
|
|
42
42
|
shape: rectangle
|
|
43
43
|
grid-columns: 2
|
|
44
44
|
|
|
45
45
|
Filtering: {
|
|
46
|
-
label: "
|
|
46
|
+
label: "オプションフィルタリング\n(互換性のない選択を防止)"
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
Conflict-Detection: {
|
|
50
|
-
label: "
|
|
50
|
+
label: "競合検出\n(複雑なニーズを特定)"
|
|
51
51
|
}
|
|
52
52
|
}
|
|
53
53
|
|
|
54
54
|
Guided-Experience: {
|
|
55
|
-
label: "3.
|
|
55
|
+
label: "3. ガイド付きエクスペリエンス"
|
|
56
56
|
shape: rectangle
|
|
57
|
-
content: "
|
|
57
|
+
content: "ユーザーには簡素化された関連オプションが表示される"
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
Final-Config: {
|
|
61
|
-
label: "4.
|
|
62
|
-
content: "config.yaml
|
|
61
|
+
label: "4. 最終設定"
|
|
62
|
+
content: "config.yamlが競合解決戦略とともに生成される"
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
User-Selections -> Wizard-Engine
|
|
66
66
|
Wizard-Engine.Filtering -> Guided-Experience
|
|
67
67
|
Wizard-Engine.Conflict-Detection -> Final-Config
|
|
68
|
-
Guided-Experience -> User-Selections: "
|
|
68
|
+
Guided-Experience -> User-Selections: "絞り込み"
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
###
|
|
71
|
+
### オプションフィルタリング
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
選択を行うと、ウィザードは後続のオプションをフィルタリングして、論理的な設定に導きます。これは、互換性のない選択を防ぐための一連の質問間競合ルールに基づいています。
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
- **リアルタイムフィルタリング**: 対象読者が「エンドユーザー(非技術的)」の場合、ウィザードは「専門家」の知識レベルを非表示にします。このルールの理由は、非技術的なユーザーは通常、経験豊富な技術ユーザーではないため、互換性のない選択を防ぐためです。
|
|
75
|
+
たとえば、ターゲットオーディエンスとして「エンドユーザー(非技術者)」を選択した場合、ウィザードは知識レベルの選択肢である「専門家である」を非表示にします。このルールの理由は、「非技術系のユーザーは通常、経験豊富な技術ユーザーではない」ということであり、非論理的な選択を防ぎます。
|
|
77
76
|
|
|
78
77
|
### 競合の検出と解決
|
|
79
78
|
|
|
80
|
-
|
|
79
|
+
場合によっては、非技術系の**エンドユーザー**と専門家の**開発者**の両方向けにドキュメントを作成するなど、効果的なドキュメント構造を必要とする複数の目標やオーディエンスが存在することがあります。ウィザードはこれらを「解決可能な競合」として識別します。
|
|
81
80
|
|
|
82
|
-
|
|
81
|
+
そして、これらのニーズにドキュメント構造内で対応するための戦略を策定します。エンドユーザー対開発者の例では、解決戦略として別々のユーザーパスを作成します。
|
|
83
82
|
|
|
84
|
-
- **ユーザーガイドパス**: 平易な言葉を使用し、UI
|
|
83
|
+
- **ユーザーガイドパス**: 平易な言葉を使用し、UIの操作に焦点を当て、ビジネス成果を志向します。
|
|
85
84
|
- **開発者ガイドパス**: コード中心で技術的に正確であり、SDKの例や設定スニペットを含みます。
|
|
86
85
|
|
|
87
|
-
|
|
86
|
+
このアプローチにより、最終的なドキュメントは、単一の混乱したコンテンツの混合物を作成するのではなく、複数のオーディエンスに効果的に対応できるように構成されます。
|
|
88
87
|
|
|
89
88
|
## 生成される出力
|
|
90
89
|
|
|
91
|
-
ウィザードを完了すると、プロジェクトに`config.yaml
|
|
90
|
+
ウィザードを完了すると、プロジェクトに`config.yaml`ファイルが保存されます。このファイルは完全にコメント化されており、各オプションの説明と利用可能なすべての選択肢がリストされているため、後で手動で確認したり変更したりするのが簡単です。
|
|
92
91
|
|
|
93
92
|
以下は生成されたファイルのスニペットです。
|
|
94
93
|
|
|
95
94
|
```yaml config.yaml icon=logos:yaml
|
|
96
|
-
#
|
|
95
|
+
# ドキュメント公開用のプロジェクト情報
|
|
97
96
|
projectName: your-project-name
|
|
98
97
|
projectDesc: Your project description.
|
|
99
98
|
projectLogo: ""
|
|
100
99
|
|
|
101
100
|
# =============================================================================
|
|
102
|
-
#
|
|
101
|
+
# Documentation Configuration
|
|
103
102
|
# =============================================================================
|
|
104
103
|
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
# getStarted -
|
|
108
|
-
# completeTasks -
|
|
104
|
+
# Purpose: What's the main outcome you want readers to achieve?
|
|
105
|
+
# Available options (uncomment and modify as needed):
|
|
106
|
+
# getStarted - すぐに始める: 新規ユーザーが30分未満でゼロから作業を開始できるように支援
|
|
107
|
+
# completeTasks - 特定のタスクを完了する: 一般的なワークフローやユースケースをユーザーに案内
|
|
109
108
|
documentPurpose:
|
|
110
109
|
- completeTasks
|
|
111
110
|
- findAnswers
|
|
112
111
|
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
# endUsers -
|
|
116
|
-
# developers -
|
|
112
|
+
# Target Audience: Who will be reading this most often?
|
|
113
|
+
# Available options (uncomment and modify as needed):
|
|
114
|
+
# endUsers - エンドユーザー (非技術者): 製品を使用するがコーディングはしない人々
|
|
115
|
+
# developers - 開発者 (製品/APIを統合): これを自分のプロジェクトに追加するエンジニア
|
|
117
116
|
targetAudienceTypes:
|
|
118
117
|
- endUsers
|
|
119
118
|
- developers
|
|
@@ -121,15 +120,19 @@ targetAudienceTypes:
|
|
|
121
120
|
# ... その他の設定
|
|
122
121
|
```
|
|
123
122
|
|
|
123
|
+
完了すると、ターミナルに確認メッセージが表示されます。
|
|
124
|
+
|
|
125
|
+

|
|
126
|
+
|
|
124
127
|
## 次のステップ
|
|
125
128
|
|
|
126
|
-
|
|
129
|
+
設定ファイルが準備できたので、ドキュメントを生成、翻訳、または公開する準備が整いました。
|
|
127
130
|
|
|
128
131
|
<x-cards>
|
|
129
132
|
<x-card data-title="ドキュメントの生成" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
|
|
130
|
-
|
|
133
|
+
単一のコマンドを使用してソースコードから完全なドキュメントセットを自動的に作成する方法を学びます。
|
|
131
134
|
</x-card>
|
|
132
135
|
<x-card data-title="設定ガイド" data-icon="lucide:settings" data-href="/configuration">
|
|
133
|
-
|
|
136
|
+
利用可能なすべての設定を深く掘り下げ、config.yamlファイルを手動で微調整する方法を学びます。
|
|
134
137
|
</x-card>
|
|
135
138
|
</x-cards>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Interactive Setup
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith includes an interactive setup wizard, launched with the `aigne doc init` command, to streamline project configuration. This guided process asks a series of questions about your documentation goals and generates a `config.yaml` file
|
|
3
|
+
AIGNE DocSmith includes an interactive setup wizard, launched with the `aigne doc init` command, to streamline project configuration. This guided process asks a series of questions about your documentation goals and generates a `config.yaml` file based on your answers. It is the recommended method for starting a new documentation project, as it helps prevent configuration errors and provides specific recommendations based on your inputs.
|
|
4
4
|
|
|
5
5
|
## Running the Wizard
|
|
6
6
|
|
|
@@ -68,12 +68,11 @@ Wizard-Engine.Conflict-Detection -> Final-Config
|
|
|
68
68
|
Guided-Experience -> User-Selections: "Refines"
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
###
|
|
71
|
+
### Option Filtering
|
|
72
72
|
|
|
73
|
-
As you make selections, the wizard
|
|
73
|
+
As you make selections, the wizard filters subsequent options to guide you toward a logical configuration. This is based on a set of cross-question conflict rules that prevent incompatible choices.
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
- **Real-time Filtering**: If your target audience is "End users (non-technical)," the wizard will hide the "Is an expert" knowledge level. The rule's reasoning is that non-technical users are typically not experienced technical users, thus preventing an incompatible selection.
|
|
75
|
+
For example, if you select "End users (non-technical)" as your target audience, the wizard will hide the "Is an expert" knowledge level option. The rule's reasoning is that "Non-technical users are typically not experienced technical users," thus preventing an illogical selection.
|
|
77
76
|
|
|
78
77
|
### Conflict Detection and Resolution
|
|
79
78
|
|
|
@@ -121,6 +120,10 @@ targetAudienceTypes:
|
|
|
121
120
|
# ... other settings
|
|
122
121
|
```
|
|
123
122
|
|
|
123
|
+
Upon completion, you will see a confirmation message in your terminal.
|
|
124
|
+
|
|
125
|
+

|
|
126
|
+
|
|
124
127
|
## Next Steps
|
|
125
128
|
|
|
126
129
|
With your configuration file in place, you are ready to generate, translate, or publish your documentation.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 互動式設定
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init`
|
|
3
|
+
AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init` 指令啟動,用以簡化專案設定。此引導式流程會詢問一系列關於您文件目標的問題,並根據您的回答產生一個 `config.yaml` 檔案。這是開始新文件專案的建議方法,因為它有助於防止設定錯誤,並根據您的輸入提供具體建議。
|
|
4
4
|
|
|
5
5
|
## 執行精靈
|
|
6
6
|
|
|
@@ -10,14 +10,14 @@ AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init`
|
|
|
10
10
|
npx aigne doc init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
接著,此精靈將引導您完成一個 8 步驟的流程來設定您的文件。
|
|
14
14
|
|
|
15
15
|
## 引導式流程
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
此精靈會提示您輸入以下關鍵設定細節:
|
|
18
18
|
|
|
19
|
-
1.
|
|
20
|
-
2.
|
|
19
|
+
1. **主要目標**:定義讀者的主要目的(例如:快速入門、尋找答案)。
|
|
20
|
+
2. **目標受眾**:指明文件的主要讀者(例如:非技術背景的終端使用者、開發人員)。
|
|
21
21
|
3. **讀者知識水平**:評估您受眾的典型起始知識水平。
|
|
22
22
|
4. **文件深度**:決定內容的詳細程度和範圍。
|
|
23
23
|
5. **主要語言**:設定文件的主要語言。
|
|
@@ -27,7 +27,7 @@ npx aigne doc init
|
|
|
27
27
|
|
|
28
28
|
## 輔助設定
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
此精靈使用一組預定義的規則來幫助您建立一個一致且有效的設定。
|
|
31
31
|
|
|
32
32
|
```d2
|
|
33
33
|
direction: down
|
|
@@ -54,12 +54,12 @@ Wizard-Engine: {
|
|
|
54
54
|
Guided-Experience: {
|
|
55
55
|
label: "3. 引導式體驗"
|
|
56
56
|
shape: rectangle
|
|
57
|
-
content: "
|
|
57
|
+
content: "使用者看到簡化、相關的選項"
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
Final-Config: {
|
|
61
61
|
label: "4. 最終設定"
|
|
62
|
-
content: "config.yaml
|
|
62
|
+
content: "config.yaml 根據\n衝突解決策略產生"
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
User-Selections -> Wizard-Engine
|
|
@@ -68,34 +68,33 @@ Wizard-Engine.Conflict-Detection -> Final-Config
|
|
|
68
68
|
Guided-Experience -> User-Selections: "優化"
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
###
|
|
71
|
+
### 選項篩選
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
當您進行選擇時,精靈會篩選後續選項,引導您達成一個合乎邏輯的設定。這是基於一組跨問題的衝突規則,用以防止不相容的選擇。
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
- **即時篩選**:如果您的目標受眾是「終端使用者(非技術人員)」,精靈將會隱藏「是專家」的知識水平選項。此規則的理由是非技術使用者通常不是經驗豐富的技術使用者,從而防止不相容的選擇。
|
|
75
|
+
例如,如果您選擇「終端使用者(非技術背景)」作為您的目標受眾,精靈將會隱藏「是專家」這個知識水平選項。該規則的理由是「非技術背景的使用者通常不是經驗豐富的技術使用者」,從而防止不合邏輯的選擇。
|
|
77
76
|
|
|
78
77
|
### 衝突偵測與解決
|
|
79
78
|
|
|
80
|
-
|
|
79
|
+
在某些情況下,您可能有多個目標或受眾,需要特定的文件結構才能有效,例如為非技術背景的**終端使用者**和專業的**開發人員**建立文件。精靈將這些情況識別為「可解決的衝突」。
|
|
81
80
|
|
|
82
|
-
|
|
81
|
+
然後,它會制定一個策略,在文件結構內解決這些需求。以終端使用者與開發人員的例子來說,解決策略是建立獨立的使用者路徑:
|
|
83
82
|
|
|
84
|
-
-
|
|
85
|
-
-
|
|
83
|
+
- **使用者指南路徑**:使用淺顯的語言,專注於使用者介面互動,並以業務成果為導向。
|
|
84
|
+
- **開發人員指南路徑**:以程式碼優先,技術上精確,並包含 SDK 範例和設定片段。
|
|
86
85
|
|
|
87
|
-
|
|
86
|
+
這種方法確保最終的文件結構能有效地服務多個受眾,而不是創造一個單一、混亂的內容組合。
|
|
88
87
|
|
|
89
88
|
## 產生的輸出
|
|
90
89
|
|
|
91
|
-
完成精靈後,它會在您的專案中儲存一個 `config.yaml`
|
|
90
|
+
完成精靈後,它會在您的專案中儲存一個 `config.yaml` 檔案。這個檔案有完整的註解,解釋了每個選項並列出了所有可用選擇,使其易於日後手動檢視和修改。
|
|
92
91
|
|
|
93
92
|
以下是產生的檔案片段:
|
|
94
93
|
|
|
95
94
|
```yaml config.yaml icon=logos:yaml
|
|
96
95
|
# 用於文件發布的專案資訊
|
|
97
96
|
projectName: your-project-name
|
|
98
|
-
projectDesc:
|
|
97
|
+
projectDesc: Your project description.
|
|
99
98
|
projectLogo: ""
|
|
100
99
|
|
|
101
100
|
# =============================================================================
|
|
@@ -110,10 +109,10 @@ documentPurpose:
|
|
|
110
109
|
- completeTasks
|
|
111
110
|
- findAnswers
|
|
112
111
|
|
|
113
|
-
#
|
|
112
|
+
# 目標受眾:誰會最常閱讀這份文件?
|
|
114
113
|
# 可用選項(取消註解並視需要修改):
|
|
115
|
-
# endUsers -
|
|
116
|
-
# developers - 開發人員整合您的產品/API
|
|
114
|
+
# endUsers - 終端使用者(非技術背景):使用產品但不寫程式的人
|
|
115
|
+
# developers - 開發人員整合您的產品/API:將此加入其專案的工程師
|
|
117
116
|
targetAudienceTypes:
|
|
118
117
|
- endUsers
|
|
119
118
|
- developers
|
|
@@ -121,6 +120,10 @@ targetAudienceTypes:
|
|
|
121
120
|
# ... 其他設定
|
|
122
121
|
```
|
|
123
122
|
|
|
123
|
+
完成後,您將在終端機中看到一條確認訊息。
|
|
124
|
+
|
|
125
|
+

|
|
126
|
+
|
|
124
127
|
## 後續步驟
|
|
125
128
|
|
|
126
129
|
設定檔案就緒後,您就可以產生、翻譯或發布您的文件了。
|
|
@@ -130,6 +133,6 @@ targetAudienceTypes:
|
|
|
130
133
|
了解如何使用單一指令從您的原始碼自動建立一套完整的文件。
|
|
131
134
|
</x-card>
|
|
132
135
|
<x-card data-title="設定指南" data-icon="lucide:settings" data-href="/configuration">
|
|
133
|
-
|
|
136
|
+
深入了解所有可用設定,並學習如何手動微調 config.yaml 檔案。
|
|
134
137
|
</x-card>
|
|
135
138
|
</x-cards>
|
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
# 交互式设置
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 包含一个交互式设置向导,通过 `aigne doc init`
|
|
3
|
+
AIGNE DocSmith 包含一个交互式设置向导,通过 `aigne doc init` 命令启动,用于简化项目配置。这个引导式过程会询问一系列关于您文档目标的问题,并根据您的回答生成一个 `config.yaml` 文件。这是启动新文档项目的推荐方法,因为它有助于防止配置错误,并根据您的输入提供具体建议。
|
|
4
4
|
|
|
5
5
|
## 运行向导
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
要开始此过程,请在您的项目根目录中运行以下命令:
|
|
8
8
|
|
|
9
9
|
```bash aigne doc init icon=lucide:sparkles
|
|
10
10
|
npx aigne doc init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
然后,向导将引导您完成一个 8
|
|
13
|
+
然后,向导将引导您完成一个 8 步流程来配置您的文档。
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## 引导式流程
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
向导会提示您输入以下关键配置详情:
|
|
18
18
|
|
|
19
19
|
1. **主要目标**:定义读者的主要目的(例如,快速入门、寻找答案)。
|
|
20
|
-
2.
|
|
20
|
+
2. **目标受众**:明确文档的主要读者(例如,非技术最终用户、开发者)。
|
|
21
21
|
3. **读者知识水平**:评估受众的典型初始知识水平。
|
|
22
22
|
4. **文档深度**:确定内容的详细程度和范围。
|
|
23
23
|
5. **主要语言**:设置文档的主要语言。
|
|
24
24
|
6. **翻译语言**:选择用于翻译的其他语言。
|
|
25
|
-
7.
|
|
25
|
+
7. **输出目录**:指定生成文档文件的位置。
|
|
26
26
|
8. **源代码路径**:定义要分析的文件和目录,支持 glob 模式。
|
|
27
27
|
|
|
28
28
|
## 辅助配置
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
向导使用一套预定义规则来帮助您创建连贯有效的配置。
|
|
31
31
|
|
|
32
32
|
```d2
|
|
33
33
|
direction: down
|
|
@@ -59,7 +59,7 @@ Guided-Experience: {
|
|
|
59
59
|
|
|
60
60
|
Final-Config: {
|
|
61
61
|
label: "4. 最终配置"
|
|
62
|
-
content: "
|
|
62
|
+
content: "config.yaml 生成时\n包含冲突解决策略"
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
User-Selections -> Wizard-Engine
|
|
@@ -68,43 +68,42 @@ Wizard-Engine.Conflict-Detection -> Final-Config
|
|
|
68
68
|
Guided-Experience -> User-Selections: "优化"
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
###
|
|
71
|
+
### 选项过滤
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
在您做出选择时,向导会过滤后续选项,以引导您进行逻辑配置。这是基于一套跨问题冲突规则,可防止不兼容的选择。
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
- **实时过滤**:如果您的目标受众是“最终用户(非技术人员)”,向导将隐藏“是专家”这个知识水平选项。该规则的理由是,非技术用户通常不是经验丰富的技术用户,从而防止了不兼容的选择。
|
|
75
|
+
例如,如果您选择“最终用户(非技术)”作为目标受众,向导将隐藏“是专家”这一知识水平选项。该规则的理由是“非技术用户通常不是经验丰富的技术用户”,从而防止不合逻辑的选择。
|
|
77
76
|
|
|
78
77
|
### 冲突检测与解决
|
|
79
78
|
|
|
80
79
|
在某些情况下,您可能有多个目标或受众,需要特定的文档结构才能有效,例如为非技术的**最终用户**和专业的**开发者**创建文档。向导将这些情况识别为“可解决的冲突”。
|
|
81
80
|
|
|
82
|
-
|
|
81
|
+
然后,它会制定一个策略,在文档结构中满足这些需求。对于最终用户与开发者的例子,解决方法是创建独立的用户路径:
|
|
83
82
|
|
|
84
|
-
- **用户指南路径**:使用通俗易懂的语言,侧重于 UI
|
|
83
|
+
- **用户指南路径**:使用通俗易懂的语言,侧重于 UI 交互,并以业务成果为导向。
|
|
85
84
|
- **开发者指南路径**:代码优先,技术上精确,并包含 SDK 示例和配置片段。
|
|
86
85
|
|
|
87
86
|
这种方法确保最终的文档结构能够有效地服务于多个受众,而不是创建一个单一、混乱的内容混合体。
|
|
88
87
|
|
|
89
88
|
## 生成的输出
|
|
90
89
|
|
|
91
|
-
完成向导后,它会在您的项目中保存一个 `config.yaml`
|
|
90
|
+
完成向导后,它会在您的项目中保存一个 `config.yaml` 文件。该文件有完整的注释,解释了每个选项并列出了所有可用选项,便于以后手动审查和修改。
|
|
92
91
|
|
|
93
92
|
以下是生成文件的片段:
|
|
94
93
|
|
|
95
94
|
```yaml config.yaml icon=logos:yaml
|
|
96
95
|
# 用于文档发布的项目信息
|
|
97
96
|
projectName: your-project-name
|
|
98
|
-
projectDesc:
|
|
97
|
+
projectDesc: Your project description.
|
|
99
98
|
projectLogo: ""
|
|
100
99
|
|
|
101
100
|
# =============================================================================
|
|
102
101
|
# 文档配置
|
|
103
102
|
# =============================================================================
|
|
104
103
|
|
|
105
|
-
#
|
|
104
|
+
# 目的:您希望读者达成的最主要成果是什么?
|
|
106
105
|
# 可用选项(根据需要取消注释并修改):
|
|
107
|
-
# getStarted - 快速入门:帮助新用户在
|
|
106
|
+
# getStarted - 快速入门:帮助新用户在 30 分钟内从零开始上手
|
|
108
107
|
# completeTasks - 完成特定任务:引导用户完成常见工作流程和用例
|
|
109
108
|
documentPurpose:
|
|
110
109
|
- completeTasks
|
|
@@ -112,8 +111,8 @@ documentPurpose:
|
|
|
112
111
|
|
|
113
112
|
# 目标受众:谁会最常阅读这份文档?
|
|
114
113
|
# 可用选项(根据需要取消注释并修改):
|
|
115
|
-
# endUsers -
|
|
116
|
-
# developers -
|
|
114
|
+
# endUsers - 最终用户(非技术):使用产品但不编写代码的人
|
|
115
|
+
# developers - 集成您的产品/API 的开发者:将此产品添加到其项目中的工程师
|
|
117
116
|
targetAudienceTypes:
|
|
118
117
|
- endUsers
|
|
119
118
|
- developers
|
|
@@ -121,9 +120,13 @@ targetAudienceTypes:
|
|
|
121
120
|
# ... 其他设置
|
|
122
121
|
```
|
|
123
122
|
|
|
123
|
+
完成后,您将在终端中看到一条确认消息。
|
|
124
|
+
|
|
125
|
+

|
|
126
|
+
|
|
124
127
|
## 后续步骤
|
|
125
128
|
|
|
126
|
-
|
|
129
|
+
配置文件就绪后,您就可以生成、翻译或发布您的文档了。
|
|
127
130
|
|
|
128
131
|
<x-cards>
|
|
129
132
|
<x-card data-title="生成文档" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
|
|
@@ -1,94 +1,64 @@
|
|
|
1
1
|
# 言語サポート
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
direction: down
|
|
9
|
-
|
|
10
|
-
Source-Doc: {
|
|
11
|
-
label: "ソースドキュメント\n(例:英語)"
|
|
12
|
-
shape: rectangle
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
AI-Engine: {
|
|
16
|
-
label: "AIGNE DocSmith\nAI翻訳エンジン"
|
|
17
|
-
shape: rectangle
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
Translated-Docs: {
|
|
21
|
-
label: "翻訳済みドキュメント"
|
|
22
|
-
shape: rectangle
|
|
23
|
-
grid-columns: 3
|
|
24
|
-
|
|
25
|
-
zh: "简体中文"
|
|
26
|
-
ja: "日本語"
|
|
27
|
-
es: "Español"
|
|
28
|
-
fr: "Français"
|
|
29
|
-
de: "Deutsch"
|
|
30
|
-
more: "..."
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
Source-Doc -> AI-Engine: "`aigne doc translate`"
|
|
34
|
-
AI-Engine -> Translated-Docs: "生成"
|
|
35
|
-
```
|
|
3
|
+
AIGNE DocSmithは、12言語へのドキュメントの自動翻訳を提供し、グローバルな読者向けのローカライズされたコンテンツの生成と維持を可能にします。この機能は主に `aigne doc translate` コマンドを通じて管理されます。
|
|
4
|
+
|
|
5
|
+
翻訳ワークフローは、AIエンジンを使用してソースドキュメントを処理し、選択したターゲット言語でバージョンを生成します。`aigne doc translate` コマンドは、翻訳するドキュメントと言語を選択するためのインタラクティブなインターフェースを提供します。
|
|
6
|
+
|
|
7
|
+

|
|
36
8
|
|
|
37
9
|
## サポートされている言語
|
|
38
10
|
|
|
39
|
-
DocSmith
|
|
40
|
-
|
|
41
|
-
|
|
|
42
|
-
|
|
43
|
-
| English | `en` |
|
|
44
|
-
| 简体中文 | `zh` |
|
|
45
|
-
| 繁體中文 | `zh-TW` |
|
|
46
|
-
| 日本語 | `ja` |
|
|
47
|
-
| 한국어 | `ko` |
|
|
48
|
-
| Español | `es` |
|
|
49
|
-
| Français | `fr` |
|
|
50
|
-
| Deutsch | `de` |
|
|
51
|
-
| Português | `pt` |
|
|
52
|
-
| Русский | `ru` |
|
|
53
|
-
| Italiano | `it` |
|
|
54
|
-
| العربية | `ar` |
|
|
11
|
+
DocSmithは、以下の言語に対するAIによる翻訳をサポートしています。プロジェクトの主要言語は `aigne doc init` による初期設定時に定義でき、以下の言語からいくつでも翻訳対象として選択できます。
|
|
12
|
+
|
|
13
|
+
| Language | Language Code |
|
|
14
|
+
|---|---|
|
|
15
|
+
| English | `en` |
|
|
16
|
+
| 简体中文 | `zh` |
|
|
17
|
+
| 繁體中文 | `zh-TW` |
|
|
18
|
+
| 日本語 | `ja` |
|
|
19
|
+
| 한국어 | `ko` |
|
|
20
|
+
| Español | `es` |
|
|
21
|
+
| Français | `fr` |
|
|
22
|
+
| Deutsch | `de` |
|
|
23
|
+
| Português | `pt` |
|
|
24
|
+
| Русский | `ru` |
|
|
25
|
+
| Italiano | `it` |
|
|
26
|
+
| العربية | `ar` |
|
|
55
27
|
|
|
56
28
|
## 翻訳の設定と使用方法
|
|
57
29
|
|
|
58
|
-
|
|
30
|
+
言語設定は、プロジェクトを初期化する際に設定します。`aigne doc translate` コマンドを使用して、いつでも新しい言語を追加したり、既存のドキュメントを翻訳したりできます。このコマンドは2つの操作モードをサポートしています。
|
|
59
31
|
|
|
60
32
|
### ガイド付き翻訳のためのインタラクティブモード
|
|
61
33
|
|
|
62
|
-
|
|
34
|
+
ステップバイステップのガイド付きプロセスについては、引数なしでコマンドを実行してください。この方法はほとんどのユーザーに推奨されます。
|
|
63
35
|
|
|
64
36
|
```bash Interactive Translation icon=lucide:wand
|
|
65
37
|
aigne doc translate
|
|
66
38
|
```
|
|
67
39
|
|
|
68
|
-
|
|
40
|
+
インタラクティブモードでは、一連のプロンプトが表示され、翻訳するドキュメントを選択し、リストからターゲット言語を選ぶことができます。このモードでは、プロジェクトの設定にまだ含まれていない新しい翻訳言語を追加することもできます。
|
|
69
41
|
|
|
70
|
-
|
|
71
|
-
2. サポートされているリストから1つ以上のターゲット言語を選択する。
|
|
72
|
-
3. プロジェクトの設定にまだ含まれていない新しい翻訳言語を追加する。
|
|
42
|
+

|
|
73
43
|
|
|
74
44
|
### 自動化のためのコマンドライン引数
|
|
75
45
|
|
|
76
|
-
|
|
46
|
+
直接制御したり、自動化スクリプトで使用したりする場合は、ドキュメントと言語をコマンドライン引数として指定できます。この方法は、CI/CDパイプラインへの統合に適しています。
|
|
77
47
|
|
|
78
48
|
```bash Command Example icon=lucide:terminal
|
|
79
|
-
# overview.mdとexamples.md
|
|
49
|
+
# overview.mdとexamples.mdを中国語と日本語に翻訳する
|
|
80
50
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
81
51
|
```
|
|
82
52
|
|
|
83
|
-
|
|
53
|
+
以下の表は、`translate` コマンドの主要なパラメータを詳述しています。
|
|
84
54
|
|
|
85
|
-
|
|
|
55
|
+
| Parameter | Description |
|
|
86
56
|
|---|---|
|
|
87
|
-
| `--langs` |
|
|
88
|
-
| `--docs` |
|
|
89
|
-
| `--feedback` |
|
|
57
|
+
| `--langs` | ターゲット言語の言語コードを指定します。このフラグを複数回使用して、複数の言語を選択できます。 |
|
|
58
|
+
| `--docs` | 翻訳するドキュメントへのパス(例:`overview.md`)を指定します。このフラグも複数回使用できます。 |
|
|
59
|
+
| `--feedback` | 翻訳モデルをガイドするための特定の指示を提供します(例:`"Use a formal tone"`)。 |
|
|
90
60
|
| `--glossary` | カスタム用語集ファイル(例:`@path/to/glossary.md`)を使用して、プロジェクト固有の用語の一貫した翻訳を保証します。 |
|
|
91
61
|
|
|
92
62
|
---
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
このセクションでは、利用可能な言語とその有効化方法の概要を説明しました。翻訳ワークフローに関する完全なガイドについては、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。
|