@aigne/doc-smith 0.8.11-beta.6 → 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 +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 +13 -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,68 +1,83 @@
|
|
|
1
1
|
# 管理偏好设置
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 旨在从您的反馈中学习。当您优化或纠正生成的内容时,DocSmith 可以将该反馈转换为持久性规则,称为偏好设置。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致的应用。所有偏好设置都存储在位于您项目根目录下的一个人类可读的 YAML 文件中:`.aigne/doc-smith/preferences.yml`。
|
|
4
4
|
|
|
5
5
|
## 偏好设置的生命周期
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
下图说明了您的反馈如何成为一个可重用的规则,该规则可以应用于未来的任务并通过命令行进行管理。
|
|
8
8
|
|
|
9
9
|
```d2 偏好设置的生命周期
|
|
10
10
|
direction: down
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
label: "
|
|
14
|
-
shape:
|
|
12
|
+
developer: {
|
|
13
|
+
label: "开发者"
|
|
14
|
+
shape: person
|
|
15
15
|
}
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
label: "
|
|
17
|
+
docsmith_system: {
|
|
18
|
+
label: "AIGNE DocSmith 系统"
|
|
19
19
|
shape: rectangle
|
|
20
|
-
}
|
|
21
20
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
cli: {
|
|
22
|
+
label: "CLI 命令\n(refine / translate)"
|
|
23
|
+
shape: rectangle
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
agent: {
|
|
27
|
+
label: "内部分析 Agent"
|
|
28
|
+
shape: rectangle
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
decision: {
|
|
32
|
+
label: "反馈是否为\n可重用策略?"
|
|
33
|
+
shape: diamond
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
create_rule: {
|
|
37
|
+
label: "创建新偏好规则"
|
|
38
|
+
shape: rectangle
|
|
39
|
+
}
|
|
25
40
|
}
|
|
26
41
|
|
|
27
|
-
|
|
28
|
-
label: "
|
|
42
|
+
preferences_file: {
|
|
43
|
+
label: ".aigne/doc-smith/preferences.yml"
|
|
29
44
|
shape: cylinder
|
|
30
45
|
}
|
|
31
46
|
|
|
32
|
-
|
|
33
|
-
label: "
|
|
34
|
-
shape:
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
cli: {
|
|
38
|
-
label: "5. CLI 管理\n('aigne doc prefs')"
|
|
39
|
-
shape: rectangle
|
|
47
|
+
one_time_fix: {
|
|
48
|
+
label: "作为一次性修复应用"
|
|
49
|
+
shape: oval
|
|
40
50
|
}
|
|
41
51
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
decision ->
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
52
|
+
developer -> docsmith_system.cli: "1. 提供反馈"
|
|
53
|
+
docsmith_system.cli -> docsmith_system.agent: "2. 捕获反馈"
|
|
54
|
+
docsmith_system.agent -> docsmith_system.decision: "3. 分析"
|
|
55
|
+
docsmith_system.decision -> docsmith_system.create_rule: "是"
|
|
56
|
+
docsmith_system.create_rule -> preferences_file: "4. 将规则保存到文件"
|
|
57
|
+
docsmith_system.decision -> one_time_fix: "否"
|
|
49
58
|
```
|
|
50
59
|
|
|
51
60
|
### 如何创建偏好设置
|
|
52
61
|
|
|
53
|
-
当您在 `refine` 或 `translate` 阶段提供反馈时,一个内部 Agent
|
|
62
|
+
当您在 `refine` 或 `translate` 阶段提供反馈时,一个内部 Agent 会分析您的输入。它会判断该反馈是一次性修复(例如,纠正拼写错误)还是可重用策略(例如,“代码注释必须用英文编写”)。如果它代表一个持久性指令,Agent 就会创建一条新的偏好规则并将其保存到您项目的 `preferences.yml` 文件中。
|
|
54
63
|
|
|
55
64
|
### 规则属性
|
|
56
65
|
|
|
57
|
-
保存在 `preferences.yml`
|
|
58
|
-
|
|
59
|
-
<x-field
|
|
60
|
-
<x-field data-name="
|
|
61
|
-
<x-field data-name="
|
|
62
|
-
<x-field data-name="
|
|
63
|
-
<x-field
|
|
64
|
-
|
|
65
|
-
<x-field data-name="
|
|
66
|
+
保存在 `preferences.yml` 中的每条规则都具有以下结构:
|
|
67
|
+
|
|
68
|
+
<x-field-group>
|
|
69
|
+
<x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符(例如,pref_a1b2c3d4e5f6g7h8)。"></x-field>
|
|
70
|
+
<x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。未激活的规则在生成任务期间将被忽略。"></x-field>
|
|
71
|
+
<x-field data-name="scope" data-type="string">
|
|
72
|
+
<x-field-desc markdown>定义规则何时应用。有效范围是 `global`、`structure`、`document` 或 `translation`。</x-field-desc>
|
|
73
|
+
</x-field>
|
|
74
|
+
<x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、提炼后的指令。"></x-field>
|
|
75
|
+
<x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈,保留以供参考。"></x-field>
|
|
76
|
+
<x-field data-name="createdAt" data-type="string" data-desc="指示规则创建时间的 ISO 8601 时间戳。"></x-field>
|
|
77
|
+
<x-field data-name="paths" data-type="string[]" data-required="false">
|
|
78
|
+
<x-field-desc markdown>一个可选的文件路径列表。如果存在,该规则仅适用于为这些特定源文件生成的内容。</x-field-desc>
|
|
79
|
+
</x-field>
|
|
80
|
+
</x-field-group>
|
|
66
81
|
|
|
67
82
|
## 使用 CLI 管理偏好设置
|
|
68
83
|
|
|
@@ -70,39 +85,39 @@ cli <-> pref_file: "管理"
|
|
|
70
85
|
|
|
71
86
|
### 列出所有偏好设置
|
|
72
87
|
|
|
73
|
-
|
|
88
|
+
要查看所有已保存的偏好设置(包括激活和未激活的)的完整列表,请使用 `--list` 标志。
|
|
74
89
|
|
|
75
90
|
```bash 列出所有偏好设置 icon=lucide:terminal
|
|
76
91
|
aigne doc prefs --list
|
|
77
92
|
```
|
|
78
93
|
|
|
79
|
-
|
|
94
|
+
该命令会显示一个格式化的列表,其中显示了每条规则的状态、范围、ID 以及任何路径限制。
|
|
80
95
|
|
|
81
|
-
```text
|
|
96
|
+
```text 输出示例 icon=lucide:clipboard-list
|
|
82
97
|
# 用户偏好设置
|
|
83
98
|
|
|
84
99
|
**格式说明:**
|
|
85
|
-
- 🟢 =
|
|
86
|
-
- [scope] =
|
|
87
|
-
- ID =
|
|
88
|
-
- Paths =
|
|
100
|
+
- 🟢 = 激活的偏好设置, ⚪ = 未激活的偏好设置
|
|
101
|
+
- [scope] = 偏好范围 (global, structure, document, translation)
|
|
102
|
+
- ID = 唯一偏好标识符
|
|
103
|
+
- Paths = 特定文件路径 (如果适用)
|
|
89
104
|
|
|
90
105
|
🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
|
|
91
|
-
|
|
106
|
+
在概览文档末尾添加一个“后续步骤”部分。
|
|
92
107
|
|
|
93
108
|
⚪ [document] pref_i9j0k1l2m3n4o5p6
|
|
94
|
-
|
|
109
|
+
代码注释必须用英文编写。
|
|
95
110
|
```
|
|
96
111
|
|
|
97
112
|
### 停用和重新激活偏好设置
|
|
98
113
|
|
|
99
|
-
|
|
114
|
+
如果您需要暂时禁用某条规则而不删除它,可以使用 `--toggle` 标志切换其激活状态。在不带 ID 的情况下运行该命令将启动交互模式,允许您选择一个或多个偏好设置进行切换。
|
|
100
115
|
|
|
101
116
|
```bash 以交互方式切换偏好设置 icon=lucide:terminal
|
|
102
117
|
aigne doc prefs --toggle
|
|
103
118
|
```
|
|
104
119
|
|
|
105
|
-
要直接切换特定规则,请使用 `--id` 标志提供其 ID
|
|
120
|
+
要直接切换特定规则,请使用 `--id` 标志提供其 ID。此操作会更改规则的 `active` 属性。
|
|
106
121
|
|
|
107
122
|
```bash 切换特定偏好设置 icon=lucide:terminal
|
|
108
123
|
aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
|
|
@@ -110,15 +125,15 @@ aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
|
|
|
110
125
|
|
|
111
126
|
### 删除偏好设置
|
|
112
127
|
|
|
113
|
-
要永久删除一个或多个偏好设置,请使用 `--remove`
|
|
128
|
+
要永久删除一个或多个偏好设置,请使用 `--remove` 标志。此操作无法撤销。
|
|
114
129
|
|
|
115
|
-
|
|
130
|
+
要获得交互式选择提示,请在不带 ID 的情况下运行该命令。
|
|
116
131
|
|
|
117
132
|
```bash 以交互方式删除偏好设置 icon=lucide:terminal
|
|
118
133
|
aigne doc prefs --remove
|
|
119
134
|
```
|
|
120
135
|
|
|
121
|
-
|
|
136
|
+
要直接删除特定规则,请使用 `--id` 标志提供其 ID。
|
|
122
137
|
|
|
123
138
|
```bash 删除特定偏好设置 icon=lucide:terminal
|
|
124
139
|
aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
|
|
@@ -126,4 +141,4 @@ aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
|
|
|
126
141
|
|
|
127
142
|
## 后续步骤
|
|
128
143
|
|
|
129
|
-
管理偏好设置是根据项目特定需求定制 DocSmith
|
|
144
|
+
管理偏好设置是根据项目特定需求定制 DocSmith 的关键部分。有关更多自定义选项,请浏览主要的[配置指南](./configuration.md)。
|
package/docs/configuration.ja.md
CHANGED
|
@@ -1,87 +1,71 @@
|
|
|
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
10
|
direction: down
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
shape:
|
|
12
|
+
User: {
|
|
13
|
+
shape: person
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
CLI: {
|
|
17
|
-
label: "
|
|
17
|
+
label: "コマンド実行\n'aigne doc init'"
|
|
18
18
|
shape: rectangle
|
|
19
19
|
}
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
label: "
|
|
21
|
+
Setup-Wizard: {
|
|
22
|
+
label: "対話式セットアップウィザード"
|
|
23
23
|
shape: rectangle
|
|
24
|
-
|
|
25
|
-
プロジェクト情報: {
|
|
26
|
-
label: "プロジェクト情報"
|
|
27
|
-
shape: rectangle
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
ドキュメント戦略: {
|
|
31
|
-
label: "ドキュメント戦略"
|
|
32
|
-
shape: rectangle
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
カスタムディレクティブ: {
|
|
36
|
-
label: "カスタムディレクティブ"
|
|
37
|
-
shape: rectangle
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
言語とパスの設定: {
|
|
41
|
-
label: "言語とパスの設定"
|
|
42
|
-
shape: rectangle
|
|
43
|
-
}
|
|
44
24
|
}
|
|
45
25
|
|
|
46
|
-
|
|
47
|
-
label: "
|
|
48
|
-
|
|
26
|
+
Config-File: {
|
|
27
|
+
label: ".aigne/doc-smith/config.yaml"
|
|
28
|
+
shape: rectangle
|
|
49
29
|
}
|
|
50
30
|
|
|
51
|
-
|
|
52
|
-
label: "
|
|
53
|
-
shape: rectangle
|
|
31
|
+
AIGNE-DocSmith-Engine: {
|
|
32
|
+
label: "AIGNE DocSmith エンジン"
|
|
54
33
|
}
|
|
55
34
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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: "設定"
|
|
61
45
|
```
|
|
62
46
|
|
|
63
|
-
##
|
|
47
|
+
## 主要な設定領域
|
|
64
48
|
|
|
65
|
-
|
|
49
|
+
ドキュメントは、いくつかの主要な設定領域によって形成されます。これらのガイドを参照して、生成プロセスの各側面を微調整する方法を理解してください。
|
|
66
50
|
|
|
67
51
|
<x-cards data-columns="2">
|
|
68
52
|
<x-card data-title="対話式セットアップ" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
|
|
69
53
|
推奨設定や競合検出を含む、ドキュメントプロジェクトの設定を支援するガイド付きウィザードについて学びます。
|
|
70
54
|
</x-card>
|
|
71
|
-
<x-card data-title="LLMセットアップ" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
|
|
72
|
-
APIキーが不要な組み込みのAIGNE
|
|
55
|
+
<x-card data-title="LLM セットアップ" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
|
|
56
|
+
APIキーが不要な組み込みのAIGNEハブの使用を含む、さまざまなAIモデルの接続方法を発見します。
|
|
73
57
|
</x-card>
|
|
74
58
|
<x-card data-title="言語サポート" data-icon="lucide:languages" data-href="/configuration/language-support">
|
|
75
|
-
|
|
59
|
+
サポートされている言語の全リストを確認し、主要言語の設定方法や自動翻訳の有効化方法を学びます。
|
|
76
60
|
</x-card>
|
|
77
61
|
<x-card data-title="設定の管理" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
|
|
78
|
-
DocSmith
|
|
62
|
+
DocSmithがフィードバックを使用して永続的なルールを作成する方法と、CLIを介してそれらを管理する方法を理解します。
|
|
79
63
|
</x-card>
|
|
80
64
|
</x-cards>
|
|
81
65
|
|
|
82
66
|
## パラメータリファレンス
|
|
83
67
|
|
|
84
|
-
`config.yaml
|
|
68
|
+
`config.yaml` ファイルには、ドキュメントの出力を制御するいくつかのキーと値のペアが含まれています。以下は、各パラメータの詳細なリファレンスです。
|
|
85
69
|
|
|
86
70
|
### プロジェクト情報
|
|
87
71
|
|
|
@@ -89,56 +73,56 @@ AIGNE-DocSmith -> 生成されたドキュメント: "生成"
|
|
|
89
73
|
|
|
90
74
|
| パラメータ | 説明 |
|
|
91
75
|
|---|---|
|
|
92
|
-
| `projectName` | プロジェクトの名前。`package.json
|
|
93
|
-
| `projectDesc` |
|
|
94
|
-
| `projectLogo` | プロジェクトのロゴ画像へのパスまたはURL。 |
|
|
76
|
+
| `projectName` | プロジェクトの名前。`package.json` があればそこから検出されます。 |
|
|
77
|
+
| `projectDesc` | プロジェクトの短い説明。`package.json` から検出されます。 |
|
|
78
|
+
| `projectLogo` | プロジェクトのロゴ画像へのパスまたは URL。 |
|
|
95
79
|
|
|
96
|
-
###
|
|
80
|
+
### ドキュメンテーション戦略
|
|
97
81
|
|
|
98
82
|
これらのパラメータは、生成されるコンテンツのトーン、スタイル、深さを定義します。
|
|
99
83
|
|
|
100
84
|
#### `documentPurpose`
|
|
101
|
-
|
|
85
|
+
読者に達成してもらいたい主な成果を定義します。この設定は、ドキュメントの全体的な構造と焦点に影響を与えます。
|
|
102
86
|
|
|
103
87
|
| オプション | 名前 | 説明 |
|
|
104
88
|
|---|---|---|
|
|
105
|
-
| `getStarted` |
|
|
89
|
+
| `getStarted` | 迅速な開始 | 新規ユーザーが30分未満でゼロから作業を開始できるように支援します。 |
|
|
106
90
|
| `completeTasks` | 特定のタスクを完了する | 一般的なワークフローとユースケースを通じてユーザーをガイドします。 |
|
|
107
|
-
| `findAnswers` |
|
|
91
|
+
| `findAnswers` | 迅速に答えを見つける | すべての機能とAPIの検索可能なリファレンスを提供します。 |
|
|
108
92
|
| `understandSystem`| システムを理解する | それがどのように機能し、なぜ設計上の決定がなされたかを説明します。 |
|
|
109
|
-
| `solveProblems` |
|
|
93
|
+
| `solveProblems` | 一般的な問題のトラブルシューティング | ユーザーが問題をトラブルシューティングし、修正するのを助けます。 |
|
|
110
94
|
| `mixedPurpose` | 複数の目的を果たす | 複数のニーズをカバーするドキュメント。 |
|
|
111
95
|
|
|
112
96
|
#### `targetAudienceTypes`
|
|
113
|
-
|
|
97
|
+
このドキュメントを最も頻繁に読むであろう人物を定義します。この選択は、ライティングスタイルと例に影響を与えます。
|
|
114
98
|
|
|
115
99
|
| オプション | 名前 | 説明 |
|
|
116
100
|
|---|---|---|
|
|
117
101
|
| `endUsers` | エンドユーザー(非技術者) | 製品を使用するがコーディングはしない人々。 |
|
|
118
102
|
| `developers` | 製品/APIを統合する開発者 | これを自分のプロジェクトに追加するエンジニア。 |
|
|
119
|
-
| `devops` | DevOps / SRE /
|
|
103
|
+
| `devops` | DevOps / SRE / インフラストラクチャチーム | システムの展開、監視、保守を行うチーム。 |
|
|
120
104
|
| `decisionMakers`| 技術的な意思決定者 | 実装を評価または計画するアーキテクトやリード。 |
|
|
121
105
|
| `supportTeams` | サポートチーム | 他の人が製品を使用するのを助ける人々。 |
|
|
122
|
-
| `mixedTechnical`|
|
|
106
|
+
| `mixedTechnical`| 混合技術オーディエンス | 開発者、DevOps、その他の技術ユーザー。 |
|
|
123
107
|
|
|
124
108
|
#### `readerKnowledgeLevel`
|
|
125
|
-
|
|
109
|
+
読者が通常、到着時に何を知っているかを定義します。これにより、どれだけの基礎知識が前提とされるかが調整されます。
|
|
126
110
|
|
|
127
111
|
| オプション | 名前 | 説明 |
|
|
128
112
|
|---|---|---|
|
|
129
|
-
| `completeBeginners` |
|
|
130
|
-
| `domainFamiliar` | 以前に類似のツールを使用したことがある |
|
|
113
|
+
| `completeBeginners` | 完全な初心者で、ゼロから始める | このドメイン/テクノロジーに全く新しい。 |
|
|
114
|
+
| `domainFamiliar` | 以前に類似のツールを使用したことがある | 問題領域は知っているが、この特定の解決策には新しい。 |
|
|
131
115
|
| `experiencedUsers` | 特定のことをしようとしている専門家 | リファレンスや高度なトピックを必要とする通常のユーザー。 |
|
|
132
116
|
| `emergencyTroubleshooting`| 緊急/トラブルシューティング | 何かが壊れており、迅速に修正する必要がある。 |
|
|
133
117
|
| `exploringEvaluating` | このツールを他と比較評価している | これが自分のニーズに合うかどうかを理解しようとしている。 |
|
|
134
118
|
|
|
135
119
|
#### `documentationDepth`
|
|
136
|
-
|
|
120
|
+
ドキュメントがどれだけ包括的であるべきかを定義します。
|
|
137
121
|
|
|
138
122
|
| オプション | 名前 | 説明 |
|
|
139
123
|
|---|---|---|
|
|
140
|
-
| `essentialOnly` |
|
|
141
|
-
| `balancedCoverage`| バランスの取れたカバレッジ |
|
|
124
|
+
| `essentialOnly` | 不可欠なもののみ | 80%のユースケースをカバーし、簡潔に保ちます。 |
|
|
125
|
+
| `balancedCoverage`| バランスの取れたカバレッジ | 実用的な例を含む適切な深さ [推奨]。 |
|
|
142
126
|
| `comprehensive` | 包括的 | すべての機能、エッジケース、高度なシナリオをカバーします。 |
|
|
143
127
|
| `aiDecide` | AIに決定させる | コードの複雑さを分析し、適切な深さを提案します。 |
|
|
144
128
|
|
|
@@ -149,7 +133,7 @@ AIGNE-DocSmith -> 生成されたドキュメント: "生成"
|
|
|
149
133
|
| パラメータ | 説明 |
|
|
150
134
|
|---|---|
|
|
151
135
|
| `rules` | 特定のドキュメント生成ルール(例:「常にパフォーマンスベンチマークを含める」)を定義できる複数行の文字列。 |
|
|
152
|
-
| `targetAudience`|
|
|
136
|
+
| `targetAudience`| プリセットで許容されるよりも詳細に特定のターゲットオーディエンスを記述するための複数行の文字列。 |
|
|
153
137
|
|
|
154
138
|
### 言語とパスの設定
|
|
155
139
|
|
|
@@ -157,54 +141,54 @@ AIGNE-DocSmith -> 生成されたドキュメント: "生成"
|
|
|
157
141
|
|
|
158
142
|
| パラメータ | 説明 |
|
|
159
143
|
|---|---|
|
|
160
|
-
| `locale` | ドキュメントの主要言語(例:`en
|
|
144
|
+
| `locale` | ドキュメントの主要言語(例:`en`、`zh`)。 |
|
|
161
145
|
| `translateLanguages` | ドキュメントを翻訳する言語コードのリスト(例:`[ja, fr, es]`)。 |
|
|
162
146
|
| `docsDir` | 生成されたドキュメントファイルが保存されるディレクトリ。 |
|
|
163
|
-
| `sourcesPath` | DocSmith
|
|
147
|
+
| `sourcesPath` | DocSmithが分析するソースコードのパスまたはグロブパターンのリスト(例:`['./src', './lib/**/*.js']`)。 |
|
|
164
148
|
| `glossary` | 一貫した翻訳を保証するために、プロジェクト固有の用語を含むマークダウンファイル(`@glossary.md`)へのパス。 |
|
|
165
149
|
|
|
166
150
|
## config.yaml の例
|
|
167
151
|
|
|
168
|
-
|
|
152
|
+
以下は、完全な設定ファイルの例です。このファイルを直接編集して、いつでも設定を変更できます。
|
|
169
153
|
|
|
170
154
|
```yaml config.yaml の例 icon=logos:yaml
|
|
171
|
-
#
|
|
155
|
+
# ドキュメント公開のためのプロジェクト情報
|
|
172
156
|
projectName: AIGNE DocSmith
|
|
173
|
-
projectDesc:
|
|
157
|
+
projectDesc: AI駆動のドキュメント生成ツール。
|
|
174
158
|
projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
|
|
175
159
|
|
|
176
160
|
# =============================================================================
|
|
177
161
|
# ドキュメント設定
|
|
178
162
|
# =============================================================================
|
|
179
163
|
|
|
180
|
-
#
|
|
181
|
-
#
|
|
164
|
+
# 目的: 読者に達成してもらいたい主な成果は何か?
|
|
165
|
+
# オプション: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
|
|
182
166
|
documentPurpose:
|
|
183
167
|
- completeTasks
|
|
184
168
|
- findAnswers
|
|
185
169
|
|
|
186
|
-
#
|
|
187
|
-
#
|
|
170
|
+
# 対象読者: これを最も頻繁に読むのは誰か?
|
|
171
|
+
# オプション: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
|
|
188
172
|
targetAudienceTypes:
|
|
189
173
|
- developers
|
|
190
174
|
|
|
191
|
-
#
|
|
192
|
-
#
|
|
175
|
+
# 読者の知識レベル: 読者は通常、到着時に何を知っているか?
|
|
176
|
+
# オプション: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
|
|
193
177
|
readerKnowledgeLevel: domainFamiliar
|
|
194
178
|
|
|
195
|
-
#
|
|
196
|
-
#
|
|
179
|
+
# ドキュメントの深さ: ドキュメントはどれだけ包括的であるべきか?
|
|
180
|
+
# オプション: essentialOnly, balancedCoverage, comprehensive, aiDecide
|
|
197
181
|
documentationDepth: balancedCoverage
|
|
198
182
|
|
|
199
|
-
#
|
|
183
|
+
# カスタムルール: 特定のドキュメント生成ルールと要件を定義します
|
|
200
184
|
rules: |+
|
|
201
185
|
|
|
202
186
|
|
|
203
|
-
#
|
|
187
|
+
# 対象読者: 特定の対象読者とその特徴を記述します
|
|
204
188
|
targetAudience: |+
|
|
205
189
|
|
|
206
190
|
|
|
207
|
-
#
|
|
191
|
+
# 用語集: プロジェクト固有の用語と定義を含むマークダウンファイルへのパス
|
|
208
192
|
# glossary: "@glossary.md"
|
|
209
193
|
|
|
210
194
|
# ドキュメントの主要言語
|
|
@@ -218,11 +202,11 @@ locale: en
|
|
|
218
202
|
# 生成されたドキュメントを保存するディレクトリ
|
|
219
203
|
docsDir: .aigne/doc-smith/docs
|
|
220
204
|
|
|
221
|
-
#
|
|
205
|
+
# 分析するソースコードのパス
|
|
222
206
|
sourcesPath:
|
|
223
207
|
- ./
|
|
224
208
|
```
|
|
225
209
|
|
|
226
210
|
設定が完了したら、プロジェクトのニーズに合ったドキュメントを作成する準備ができました。次のステップは、生成コマンドを実行することです。
|
|
227
211
|
|
|
228
|
-
➡️
|
|
212
|
+
➡️ **次へ:** [ドキュメントの生成](./features-generate-documentation.md)
|
package/docs/configuration.md
CHANGED
|
@@ -10,54 +10,38 @@ The following diagram illustrates the configuration workflow:
|
|
|
10
10
|
direction: down
|
|
11
11
|
|
|
12
12
|
User: {
|
|
13
|
-
shape:
|
|
13
|
+
shape: person
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
CLI: {
|
|
17
|
-
label: "
|
|
17
|
+
label: "Run Command\n'aigne doc init'"
|
|
18
18
|
shape: rectangle
|
|
19
19
|
}
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
label: "
|
|
21
|
+
Setup-Wizard: {
|
|
22
|
+
label: "Interactive Setup Wizard"
|
|
23
23
|
shape: rectangle
|
|
24
|
-
|
|
25
|
-
Project-Info: {
|
|
26
|
-
label: "Project Information"
|
|
27
|
-
shape: rectangle
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
Doc-Strategy: {
|
|
31
|
-
label: "Documentation Strategy"
|
|
32
|
-
shape: rectangle
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
Custom-Directives: {
|
|
36
|
-
label: "Custom Directives"
|
|
37
|
-
shape: rectangle
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
Lang-Path: {
|
|
41
|
-
label: "Language & Path Config"
|
|
42
|
-
shape: rectangle
|
|
43
|
-
}
|
|
44
24
|
}
|
|
45
25
|
|
|
46
|
-
|
|
47
|
-
label: "
|
|
48
|
-
|
|
26
|
+
Config-File: {
|
|
27
|
+
label: ".aigne/doc-smith/config.yaml"
|
|
28
|
+
shape: rectangle
|
|
49
29
|
}
|
|
50
30
|
|
|
51
|
-
|
|
52
|
-
label: "
|
|
53
|
-
shape: rectangle
|
|
31
|
+
AIGNE-DocSmith-Engine: {
|
|
32
|
+
label: "AIGNE DocSmith Engine"
|
|
54
33
|
}
|
|
55
34
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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"
|
|
61
45
|
```
|
|
62
46
|
|
|
63
47
|
## Core Configuration Areas
|