@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,45 +1,46 @@
|
|
|
1
1
|
# 翻譯文件
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 可以將您的文件翻譯成 12
|
|
3
|
+
AIGNE DocSmith 可以將您的文件翻譯成 12 種不同的語言,包括英文、中文和西班牙文,讓您的專案能觸及全球受眾。該工具提供兩種管理翻譯的方式:用於引導式設定的互動模式,以及用於精確控制和自動化的命令列參數。
|
|
4
4
|
|
|
5
5
|
## 互動式翻譯
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
若要獲得引導式體驗,請執行不含任何參數的 `translate` 命令。此方法非常適合偏好逐步操作的使用者。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
此命令會啟動一個互動式精靈,引導您完成整個過程:
|
|
14
14
|
|
|
15
|
-
1.
|
|
15
|
+
1. **選擇要翻譯的文件:** 系統會顯示您現有文件的列表。使用空格鍵選擇您要翻譯的文件。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
|
-
2. **選擇目標語言:**
|
|
19
|
+
2. **選擇目標語言:** 選擇文件後,從支援的選項列表中選擇一種或多種目標語言。
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
|
-
3. **確認並執行:** DocSmith
|
|
23
|
+
3. **確認並執行:** DocSmith 隨後會處理翻譯,為您選擇的每個檔案生成對應各種語言的新版本。
|
|
24
24
|
|
|
25
25
|
## 命令列翻譯
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
對於在腳本或 CI/CD 流程中進行自動化,請使用命令列旗標來控制翻譯過程。此方法為開發人員和進階使用者提供了更大的靈活性。
|
|
28
28
|
|
|
29
29
|
### 命令參數
|
|
30
30
|
|
|
31
31
|
<x-field-group>
|
|
32
|
-
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="
|
|
33
|
-
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="
|
|
34
|
-
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI
|
|
35
|
-
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一種目標語言。此旗標可多次使用以包含多種語言(例如,--langs zh --langs ja)。"></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻譯的文件路徑。此旗標也可多次使用以進行批次翻譯。"></x-field>
|
|
34
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建議以引導翻譯品質(例如,--feedback "使用正式語氣")。"></x-field>
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的詞彙表檔案,以確保特定術語的一致性(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻譯模型,例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
|
|
36
37
|
</x-field-group>
|
|
37
38
|
|
|
38
39
|
### 範例
|
|
39
40
|
|
|
40
41
|
#### 翻譯特定文件
|
|
41
42
|
|
|
42
|
-
|
|
43
|
+
若要將 `overview.md` 和 `examples.md` 翻譯成中文和日文,請執行以下命令:
|
|
43
44
|
|
|
44
45
|
```bash
|
|
45
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -53,29 +54,37 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
53
54
|
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
55
|
```
|
|
55
56
|
|
|
57
|
+
#### 指定翻譯模型
|
|
58
|
+
|
|
59
|
+
若要使用特定的 AI 模型執行翻譯任務,請使用 `--model` 旗標。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
63
|
+
```
|
|
64
|
+
|
|
56
65
|
## 支援的語言
|
|
57
66
|
|
|
58
67
|
DocSmith 支援以下 12 種語言的自動翻譯:
|
|
59
68
|
|
|
60
|
-
| 語言
|
|
69
|
+
| 語言 | 代碼 |
|
|
61
70
|
| -------------------- | ------- |
|
|
62
|
-
| 英文
|
|
63
|
-
| 簡體中文
|
|
64
|
-
| 繁體中文
|
|
65
|
-
| 日文
|
|
66
|
-
| 韓文
|
|
67
|
-
| 西班牙文
|
|
68
|
-
| 法文
|
|
69
|
-
| 德文
|
|
70
|
-
| 葡萄牙文
|
|
71
|
-
| 俄文
|
|
72
|
-
| 義大利文
|
|
73
|
-
| 阿拉伯文
|
|
71
|
+
| 英文 | `en` |
|
|
72
|
+
| 簡體中文 | `zh-CN` |
|
|
73
|
+
| 繁體中文 | `zh-TW` |
|
|
74
|
+
| 日文 | `ja` |
|
|
75
|
+
| 韓文 | `ko` |
|
|
76
|
+
| 西班牙文 | `es` |
|
|
77
|
+
| 法文 | `fr` |
|
|
78
|
+
| 德文 | `de` |
|
|
79
|
+
| 葡萄牙文 | `pt-BR` |
|
|
80
|
+
| 俄文 | `ru` |
|
|
81
|
+
| 義大利文 | `it` |
|
|
82
|
+
| 阿拉伯文 | `ar` |
|
|
74
83
|
|
|
75
84
|
---
|
|
76
85
|
|
|
77
86
|
文件翻譯完成後,您就可以與全世界分享了。
|
|
78
87
|
|
|
79
88
|
<x-card data-title="下一步:發佈您的文件" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="閱讀更多">
|
|
80
|
-
|
|
89
|
+
關於如何輕鬆將您的文件發佈到公共平台或您自己的私人網站的指南。
|
|
81
90
|
</x-card>
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# 翻译文档
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 可以将您的文档翻译成 12
|
|
3
|
+
AIGNE DocSmith 可以将您的文档翻译成 12 种不同的语言,包括英语、中文和西班牙语,让您的项目触达全球受众。该工具提供两种管理翻译的方式:用于引导式设置的交互模式和用于精确控制和自动化的命令行参数。
|
|
4
4
|
|
|
5
5
|
## 交互式翻译
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
要获得引导式体验,请在不带任何参数的情况下运行 `translate` 命令。此方法非常适合偏好分步操作的用户。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
@@ -12,34 +12,35 @@ aigne doc translate
|
|
|
12
12
|
|
|
13
13
|
此命令会启动一个交互式向导,引导您完成整个过程:
|
|
14
14
|
|
|
15
|
-
1. **选择要翻译的文档:**
|
|
15
|
+
1. **选择要翻译的文档:** 您将看到一个现有文档的列表。使用空格键选择您想要翻译的文档。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
|
-
2. **选择目标语言:**
|
|
19
|
+
2. **选择目标语言:** 选择文档后,从支持的选项列表中选择一种或多种目标语言。
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
23
|
3. **确认并运行:** DocSmith 随后将处理翻译,为每个选定的语言生成所选文件的新版本。
|
|
24
24
|
|
|
25
25
|
## 命令行翻译
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
要在脚本或 CI/CD 管道中实现自动化,请使用命令行标志来控制翻译过程。此方法为开发人员和高级用户提供了更大的灵活性。
|
|
28
28
|
|
|
29
29
|
### 命令参数
|
|
30
30
|
|
|
31
31
|
<x-field-group>
|
|
32
|
-
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="
|
|
33
|
-
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一个目标语言。此标志可以多次使用以包含多种语言(例如,--langs zh --langs ja)。"></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻译的文档路径。此标志也可以多次使用以进行批量翻译。"></x-field>
|
|
34
34
|
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建议以指导翻译质量(例如,--feedback "使用正式语气")。"></x-field>
|
|
35
|
-
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的术语表文件,以确保特定术语的用词一致(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻译模型,例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
|
|
36
37
|
</x-field-group>
|
|
37
38
|
|
|
38
39
|
### 示例
|
|
39
40
|
|
|
40
41
|
#### 翻译特定文档
|
|
41
42
|
|
|
42
|
-
要将 `overview.md` 和 `examples.md`
|
|
43
|
+
要将 `overview.md` 和 `examples.md` 翻译成中文和日文,请运行以下命令:
|
|
43
44
|
|
|
44
45
|
```bash
|
|
45
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -47,12 +48,20 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
47
48
|
|
|
48
49
|
#### 使用术语表和反馈
|
|
49
50
|
|
|
50
|
-
|
|
51
|
+
为确保品牌名称和技术术语翻译正确,您可以提供一个术语表文件。您还可以提供反馈以改进翻译风格。
|
|
51
52
|
|
|
52
53
|
```bash
|
|
53
54
|
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
55
|
```
|
|
55
56
|
|
|
57
|
+
#### 指定翻译模型
|
|
58
|
+
|
|
59
|
+
要使用特定的 AI 模型执行翻译任务,请使用 `--model` 标志。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
63
|
+
```
|
|
64
|
+
|
|
56
65
|
## 支持的语言
|
|
57
66
|
|
|
58
67
|
DocSmith 支持以下 12 种语言的自动翻译:
|
|
@@ -74,8 +83,8 @@ DocSmith 支持以下 12 种语言的自动翻译:
|
|
|
74
83
|
|
|
75
84
|
---
|
|
76
85
|
|
|
77
|
-
|
|
86
|
+
文档翻译完成后,您就可以与全世界分享了。
|
|
78
87
|
|
|
79
88
|
<x-card data-title="下一步:发布您的文档" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="阅读更多">
|
|
80
|
-
|
|
89
|
+
一份关于如何轻松将您的文档发布到公共平台或您自己的私人网站的指南。
|
|
81
90
|
</x-card>
|
|
@@ -1,192 +1,142 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 更新と改良
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
進化するコードベースとドキュメントを同期させることは、系統的なプロセスです。AIGNE DocSmith は、コードの変更に基づく自動更新、またはフィードバックに基づいた正確な改良を通じて、コンテンツを最新の状態に保つための直接的で柔軟なコマンドを提供します。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
このガイドでは、以下のタスクの手順を説明します。
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
* ソースコードが変更されたときにドキュメントを自動的に更新する。
|
|
8
|
+
* ターゲットを絞ったフィードバックを使用して特定のドキュメントを再生成する。
|
|
9
|
+
* ドキュメント全体の構造を調整する。
|
|
10
10
|
|
|
11
11
|
### ドキュメント更新ワークフロー
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
以下の図は、ドキュメントを更新するために利用可能なさまざまなワークフローを示しています。
|
|
14
14
|
|
|
15
15
|
```d2 ドキュメント更新ワークフロー
|
|
16
16
|
direction: down
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Developer: {
|
|
19
19
|
shape: c4-person
|
|
20
|
-
label: "開発者"
|
|
21
20
|
}
|
|
22
21
|
|
|
23
|
-
|
|
24
|
-
shape: cylinder
|
|
22
|
+
Source-Code: {
|
|
25
23
|
label: "ソースコード"
|
|
26
24
|
}
|
|
27
25
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
label: "更新された\nドキュメント"
|
|
26
|
+
Documentation: {
|
|
27
|
+
label: "ドキュメント"
|
|
31
28
|
}
|
|
32
29
|
|
|
33
|
-
|
|
34
|
-
label: "
|
|
30
|
+
Action-Choice: {
|
|
31
|
+
label: "アクションを選択"
|
|
32
|
+
shape: diamond
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
Generate-Sync: {
|
|
36
|
+
label: "aigne doc generate"
|
|
35
37
|
shape: rectangle
|
|
36
38
|
|
|
37
|
-
|
|
38
|
-
label: "
|
|
39
|
-
shape:
|
|
39
|
+
Change-Detection: {
|
|
40
|
+
label: "変更を検出?"
|
|
41
|
+
shape: diamond
|
|
42
|
+
}
|
|
43
|
+
Regenerate-Affected: "影響を受けるものを再生成"
|
|
44
|
+
Regenerate-All: "すべてを再生成"
|
|
40
45
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
46
|
+
Change-Detection -> Regenerate-Affected: "はい (デフォルト)"
|
|
47
|
+
Change-Detection -> Regenerate-All: "いいえ\n(--forceRegenerate)"
|
|
48
|
+
}
|
|
44
49
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
}
|
|
50
|
+
Refine-Content: {
|
|
51
|
+
label: "aigne doc update"
|
|
52
|
+
}
|
|
49
53
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
54
|
+
Refine-Structure: {
|
|
55
|
+
label: "aigne doc generate\n--feedback"
|
|
56
|
+
}
|
|
53
57
|
|
|
54
|
-
|
|
55
|
-
label: "影響を受ける\nドキュメントを再生成"
|
|
56
|
-
}
|
|
58
|
+
Developer -> Action-Choice
|
|
57
59
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
}
|
|
60
|
+
Action-Choice -> Generate-Sync: "コードと同期"
|
|
61
|
+
Action-Choice -> Refine-Content: "ドキュメント内容を改良"
|
|
62
|
+
Action-Choice -> Refine-Structure: "ドキュメント構造を改良"
|
|
62
63
|
|
|
63
|
-
|
|
64
|
-
label: "手動リファイン (フィードバック駆動)"
|
|
65
|
-
shape: rectangle
|
|
66
|
-
grid-columns: 2
|
|
67
|
-
grid-gap: 100
|
|
68
|
-
|
|
69
|
-
refine-individual: {
|
|
70
|
-
label: "個別ドキュメントのリファイン"
|
|
71
|
-
shape: rectangle
|
|
72
|
-
|
|
73
|
-
cmd-update: {
|
|
74
|
-
label: "aigne doc update\n--feedback"
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
regen-specific: {
|
|
78
|
-
label: "特定の\nドキュメントを再生成"
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
optimize-structure: {
|
|
83
|
-
label: "全体構造の最適化"
|
|
84
|
-
shape: rectangle
|
|
85
|
-
|
|
86
|
-
cmd-generate-feedback: {
|
|
87
|
-
label: "aigne doc generate\n--feedback"
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
re-evaluate-plan: {
|
|
91
|
-
label: "ドキュメント計画\nの再評価"
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
}
|
|
64
|
+
Source-Code -> Generate-Sync
|
|
96
65
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
codebase -> workflows.automatic-updates.cmd-generate: "2. コマンドを実行"
|
|
102
|
-
workflows.automatic-updates.cmd-generate -> workflows.automatic-updates.decision-force
|
|
103
|
-
workflows.automatic-updates.decision-force -> workflows.automatic-updates.detect-changes: "いいえ"
|
|
104
|
-
workflows.automatic-updates.detect-changes -> workflows.automatic-updates.regen-affected
|
|
105
|
-
workflows.automatic-updates.decision-force -> workflows.automatic-updates.regen-all: "はい"
|
|
106
|
-
workflows.automatic-updates.regen-affected -> updated-documentation
|
|
107
|
-
workflows.automatic-updates.regen-all -> updated-documentation
|
|
108
|
-
|
|
109
|
-
# パス2: 個別リファイン
|
|
110
|
-
developer -> workflows.manual-refinements.refine-individual.cmd-update: "3. コンテンツの\nフィードバックを提供"
|
|
111
|
-
workflows.manual-refinements.refine-individual.cmd-update -> workflows.manual-refinements.refine-individual.regen-specific
|
|
112
|
-
workflows.manual-refinements.refine-individual.regen-specific -> updated-documentation
|
|
113
|
-
|
|
114
|
-
# パス3: 構造リファイン
|
|
115
|
-
developer -> workflows.manual-refinements.optimize-structure.cmd-generate-feedback: "4. 構造に関する\nフィードバックを提供"
|
|
116
|
-
workflows.manual-refinements.optimize-structure.cmd-generate-feedback -> workflows.manual-refinements.optimize-structure.re-evaluate-plan
|
|
117
|
-
workflows.manual-refinements.optimize-structure.re-evaluate-plan -> updated-documentation: "新しい構造で\n再生成"
|
|
66
|
+
Generate-Sync.Regenerate-Affected -> Documentation: "更新"
|
|
67
|
+
Generate-Sync.Regenerate-All -> Documentation: "更新"
|
|
68
|
+
Refine-Content -> Documentation: "更新"
|
|
69
|
+
Refine-Structure -> Documentation: "更新"
|
|
118
70
|
```
|
|
119
71
|
|
|
120
72
|
---
|
|
121
73
|
|
|
122
74
|
## 変更検出による自動更新
|
|
123
75
|
|
|
124
|
-
`aigne doc generate
|
|
76
|
+
`aigne doc generate` コマンドを実行すると、DocSmith はまずコードベースを分析して、最後の生成以降の変更を検出します。次に、これらの変更によって影響を受けるドキュメントのみを再生成します。このデフォルトの動作により、冗長な操作を回避することで、時間を節約し、API の使用量を削減します。
|
|
125
77
|
|
|
126
78
|
```shell icon=lucide:terminal
|
|
127
|
-
# DocSmith
|
|
79
|
+
# DocSmith が変更を検出し、必要なものだけを更新します
|
|
128
80
|
aigne doc generate
|
|
129
81
|
```
|
|
130
82
|
|
|
131
|
-

|
|
132
84
|
|
|
133
85
|
### 完全な再生成の強制
|
|
134
86
|
|
|
135
|
-
|
|
87
|
+
キャッシュと変更検出をバイパスして、すべてのドキュメントを最初から再生成するには、`--forceRegenerate` フラグを使用します。これは、大幅な設定変更を行った場合や、すべてのファイルで一貫性を確保するために完全な再構築が必要な場合に必要です。
|
|
136
88
|
|
|
137
89
|
```shell icon=lucide:terminal
|
|
138
|
-
#
|
|
90
|
+
# すべてのドキュメントをゼロから再生成する
|
|
139
91
|
aigne doc generate --forceRegenerate
|
|
140
92
|
```
|
|
141
93
|
|
|
142
94
|
---
|
|
143
95
|
|
|
144
|
-
##
|
|
96
|
+
## フィードバックによるドキュメントの改良
|
|
97
|
+
|
|
98
|
+
対応するコードの変更なしに、CLI コマンドに直接フィードバックを提供することでドキュメントを改良できます。これは、明確さを向上させたり、例を追加したり、構造を調整したりするのに役立ちます。
|
|
145
99
|
|
|
146
|
-
|
|
100
|
+
### 個別ドキュメント内容の改良
|
|
147
101
|
|
|
148
|
-
|
|
102
|
+
特定のドキュメントの内容を改善するには、`aigne doc update` コマンドを使用します。このコマンドを使用すると、改良のための具体的な指示を提供でき、インタラクティブモードと非インタラクティブモードの2つのモードで実行できます。
|
|
149
103
|
|
|
150
|
-
|
|
104
|
+
#### インタラクティブモード
|
|
151
105
|
|
|
152
|
-
|
|
106
|
+
ガイド付きのプロセスについては、引数なしでコマンドを実行します。DocSmith は、更新したいドキュメントを選択するためのメニューを表示します。選択後、フィードバックを入力するよう求められます。
|
|
153
107
|
|
|
154
108
|
```shell icon=lucide:terminal
|
|
155
|
-
#
|
|
109
|
+
# インタラクティブな更新プロセスを開始する
|
|
156
110
|
aigne doc update
|
|
157
111
|
```
|
|
158
112
|
|
|
159
|
-

|
|
160
114
|
|
|
161
|
-
|
|
115
|
+
#### 非インタラクティブモード
|
|
162
116
|
|
|
163
|
-
|
|
117
|
+
スクリプト化された、またはより高速なワークフローの場合、フラグを使用してドキュメントとフィードバックを直接指定できます。これにより、正確な非インタラクティブな更新が可能になります。
|
|
164
118
|
|
|
165
119
|
```shell icon=lucide:terminal
|
|
166
|
-
#
|
|
167
|
-
aigne doc update --docs overview.md --feedback "
|
|
120
|
+
# 特定のドキュメントをフィードバックで更新する
|
|
121
|
+
aigne doc update --docs overview.md --feedback "最後に、より詳細な FAQ セクションを追加してください。"
|
|
168
122
|
```
|
|
169
123
|
|
|
170
|
-
`update
|
|
124
|
+
`update` コマンドの主要なパラメータは次のとおりです。
|
|
171
125
|
|
|
172
126
|
| パラメータ | 説明 |
|
|
173
|
-
|
|
|
127
|
+
| :--- | :--- |
|
|
174
128
|
| `--docs` | 更新するドキュメントへのパス。このフラグはバッチ更新のために複数回使用できます。 |
|
|
175
|
-
| `--feedback` |
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
## 全体構造の最適化
|
|
129
|
+
| `--feedback` | ドキュメントのコンテンツを再生成する際に使用される具体的な指示を含む文字列。 |
|
|
180
130
|
|
|
181
|
-
|
|
131
|
+
### 全体構造の最適化
|
|
182
132
|
|
|
183
|
-
|
|
133
|
+
個々のドキュメントの改良に加えて、ドキュメント全体の構造を調整することもできます。既存の構成が最適でない場合やセクションが欠落している場合は、`generate` コマンドにフィードバックを提供できます。これにより、DocSmith はあなたの入力に基づいてドキュメントプラン全体を再評価するよう指示されます。
|
|
184
134
|
|
|
185
135
|
```shell icon=lucide:terminal
|
|
186
|
-
#
|
|
136
|
+
# 特定のフィードバックでドキュメント構造を再生成する
|
|
187
137
|
aigne doc generate --feedback "'概要'セクションを削除し、詳細な'APIリファレンス'を追加してください。"
|
|
188
138
|
```
|
|
189
139
|
|
|
190
|
-
|
|
140
|
+
このアプローチは、単一ファイル内のマイナーなコンテンツ編集ではなく、ドキュメントの目次に対する高レベルの変更を目的としています。
|
|
191
141
|
|
|
192
|
-
|
|
142
|
+
コンテンツが改良されたら、次のステップはそれを世界中の読者に向けて準備することです。手順については、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。
|