@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.6

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.
Files changed (95) hide show
  1. package/.aigne/doc-smith/config.yaml +1 -1
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +9 -2
  4. package/README.md +1 -1
  5. package/agents/clear/choose-contents.mjs +2 -2
  6. package/agents/clear/clear-document-structure.mjs +8 -8
  7. package/agents/clear/index.yaml +1 -1
  8. package/agents/evaluate/document-structure.yaml +1 -1
  9. package/agents/generate/check-document-structure.yaml +3 -3
  10. package/agents/generate/check-need-generate-structure.mjs +8 -8
  11. package/agents/generate/document-structure-tools/add-document.mjs +3 -3
  12. package/agents/generate/document-structure-tools/delete-document.mjs +2 -2
  13. package/agents/generate/document-structure-tools/move-document.mjs +3 -2
  14. package/agents/generate/document-structure-tools/update-document.mjs +2 -2
  15. package/agents/generate/generate-structure.yaml +1 -1
  16. package/agents/generate/update-document-structure.yaml +3 -3
  17. package/agents/generate/user-review-document-structure.mjs +10 -10
  18. package/agents/update/batch-generate-document.yaml +1 -1
  19. package/agents/update/check-document.mjs +2 -2
  20. package/agents/utils/check-feedback-refiner.mjs +1 -1
  21. package/agents/utils/choose-docs.mjs +1 -1
  22. package/agents/utils/load-document-all-content.mjs +3 -3
  23. package/agents/utils/load-sources.mjs +1 -1
  24. package/agents/utils/save-docs.mjs +7 -28
  25. package/aigne.yaml +2 -2
  26. package/docs/_sidebar.md +1 -1
  27. package/docs/advanced-how-it-works.md +3 -3
  28. package/docs/advanced-quality-assurance.md +1 -1
  29. package/docs/cli-reference.ja.md +151 -80
  30. package/docs/cli-reference.md +126 -55
  31. package/docs/cli-reference.zh-TW.md +133 -62
  32. package/docs/cli-reference.zh.md +143 -72
  33. package/docs/configuration-interactive-setup.md +1 -1
  34. package/docs/configuration-language-support.md +1 -1
  35. package/docs/configuration-preferences.md +1 -1
  36. package/docs/configuration.ja.md +104 -48
  37. package/docs/configuration.md +58 -2
  38. package/docs/configuration.zh-TW.md +99 -42
  39. package/docs/configuration.zh.md +78 -21
  40. package/docs/features-generate-documentation.ja.md +63 -44
  41. package/docs/features-generate-documentation.md +54 -35
  42. package/docs/features-generate-documentation.zh-TW.md +67 -48
  43. package/docs/features-generate-documentation.zh.md +61 -41
  44. package/docs/features-publish-your-docs.ja.md +69 -46
  45. package/docs/features-publish-your-docs.md +65 -42
  46. package/docs/features-publish-your-docs.zh-TW.md +73 -50
  47. package/docs/features-publish-your-docs.zh.md +67 -44
  48. package/docs/features-translate-documentation.ja.md +35 -33
  49. package/docs/features-translate-documentation.md +24 -22
  50. package/docs/features-translate-documentation.zh-TW.md +32 -30
  51. package/docs/features-translate-documentation.zh.md +29 -27
  52. package/docs/features-update-and-refine.ja.md +120 -66
  53. package/docs/features-update-and-refine.md +110 -56
  54. package/docs/features-update-and-refine.zh-TW.md +116 -62
  55. package/docs/features-update-and-refine.zh.md +118 -64
  56. package/docs/getting-started.ja.md +22 -22
  57. package/docs/getting-started.md +1 -1
  58. package/docs/getting-started.zh-TW.md +16 -16
  59. package/docs/getting-started.zh.md +28 -28
  60. package/docs/overview.md +3 -3
  61. package/docs-mcp/analyze-docs-relevance.yaml +6 -6
  62. package/docs-mcp/docs-search.yaml +1 -1
  63. package/package.json +2 -2
  64. package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
  65. package/prompts/common/document-structure/document-structure-rules.md +2 -2
  66. package/prompts/detail/document-rules.md +1 -1
  67. package/prompts/detail/generate-document.md +1 -1
  68. package/prompts/evaluate/document-structure.md +6 -6
  69. package/prompts/structure/check-document-structure.md +10 -10
  70. package/prompts/structure/document-rules.md +2 -2
  71. package/prompts/structure/generate-structure-system.md +3 -3
  72. package/prompts/structure/structure-example.md +1 -1
  73. package/prompts/structure/structure-getting-started.md +1 -1
  74. package/prompts/structure/update-document-structure.md +9 -9
  75. package/prompts/utils/feedback-refiner.md +1 -1
  76. package/tests/agents/clear/choose-contents.test.mjs +1 -1
  77. package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
  78. package/tests/agents/evaluate/generate-report.test.mjs +1 -1
  79. package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
  80. package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
  81. package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
  82. package/tests/agents/generate/document-structure-tools/move-document.test.mjs +3 -3
  83. package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
  84. package/tests/agents/generate/user-review-document-structure.test.mjs +7 -5
  85. package/tests/agents/update/check-document.test.mjs +1 -1
  86. package/tests/agents/utils/format-document-structure.test.mjs +5 -5
  87. package/tests/agents/utils/load-sources.test.mjs +4 -4
  88. package/tests/agents/utils/save-docs.test.mjs +1 -1
  89. package/tests/utils/conflict-detector.test.mjs +1 -1
  90. package/tests/utils/docs-finder-utils.test.mjs +8 -8
  91. package/types/document-structure-schema.mjs +9 -9
  92. package/utils/conflict-detector.mjs +1 -1
  93. package/utils/constants/index.mjs +4 -4
  94. package/utils/docs-finder-utils.mjs +11 -11
  95. package/utils/markdown-checker.mjs +1 -1
@@ -1,73 +1,127 @@
1
- # 更新與優化
1
+ # 更新與完善
2
2
 
3
- 讓文件與不斷演進的程式碼庫保持同步是一項關鍵任務。AIGNE DocSmith 提供了直接且靈活的方法來讓您的內容保持最新,無論是透過基於程式碼變更的自動更新,還是透過精確、由回饋意見驅動的優化。
3
+ 讓文件與不斷演進的程式碼庫保持同步是一個有條理的過程。AIGNE DocSmith 提供了直接而靈活的指令,可透過基於程式碼變更的自動更新,或透過精確、由回饋驅動的完善來讓您的內容保持最新。
4
4
 
5
- 本指南涵蓋如何:
5
+ 本指南涵蓋以下程序:
6
6
 
7
- - 在您的原始碼變更時自動更新文件。
8
- - 使用針對性的回饋意見重新生成特定文件。
7
+ - 在原始碼被修改時自動更新文件。
8
+ - 使用針對性的回饋重新生成特定文件。
9
9
  - 調整整體文件結構。
10
10
 
11
11
  ### 文件更新工作流程
12
12
 
13
- 下圖說明了更新文件的不同路徑:
13
+ 下圖說明了可用於更新文件的不同工作流程:
14
14
 
15
- ```d2 更新工作流程
15
+ ```d2 文件更新工作流程
16
16
  direction: down
17
17
 
18
- Start: {
19
- shape: circle
20
- label: "開始"
18
+ developer: {
19
+ shape: c4-person
20
+ label: "開發人員"
21
21
  }
22
22
 
23
- Code-Change: {
24
- label: "原始碼或\n設定檔變更"
25
- shape: rectangle
23
+ codebase: {
24
+ shape: cylinder
25
+ label: "原始碼"
26
26
  }
27
27
 
28
- Content-Tweak: {
29
- label: "需要內容\n改善?"
30
- shape: rectangle
28
+ updated-documentation: {
29
+ shape: cylinder
30
+ label: "已更新的\n文件"
31
31
  }
32
32
 
33
- Structure-Tweak: {
34
- label: "需要結構\n改善?"
33
+ workflows: {
34
+ label: "文件更新工作流程"
35
35
  shape: rectangle
36
- }
37
-
38
- Start -> Code-Change
39
- Start -> Content-Tweak
40
- Start -> Structure-Tweak
41
-
42
- Code-Change -> Generate-Command: "aigne doc generate"
43
-
44
- Generate-Command -> Change-Detection: {
45
- label: "變更偵測"
46
- shape: diamond
47
- }
48
- Change-Detection -> Auto-Regen: "重新生成\n受影響文件"
49
-
50
- Content-Tweak -> Update-Command: "aigne doc update\n--feedback"
51
- Update-Command -> Manual-Regen: "重新生成\n特定文件"
52
-
53
- Structure-Tweak -> Generate-Feedback-Command: "aigne doc generate\n--feedback"
54
- Generate-Feedback-Command -> Replan: "重新規劃文件\n結構"
55
36
 
56
- End: {
57
- shape: circle
58
- label: "文件已更新"
37
+ automatic-updates: {
38
+ label: "自動更新(程式碼驅動)"
39
+ shape: rectangle
40
+
41
+ cmd-generate: {
42
+ label: "aigne doc generate"
43
+ }
44
+
45
+ decision-force: {
46
+ label: "--forceRegenerate?"
47
+ shape: diamond
48
+ }
49
+
50
+ detect-changes: {
51
+ label: "偵測變更"
52
+ }
53
+
54
+ regen-affected: {
55
+ label: "重新生成\n受影響文件"
56
+ }
57
+
58
+ regen-all: {
59
+ label: "重新生成\n所有文件"
60
+ }
61
+ }
62
+
63
+ manual-refinements: {
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
+ }
59
95
  }
60
96
 
61
- Auto-Regen -> End
62
- Manual-Regen -> End
63
- Replan -> End
97
+ # --- Connections ---
98
+
99
+ # Path 1: Automatic Updates
100
+ developer -> codebase: "1. 進行變更"
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
+ # Path 2: Individual Refinement
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
+ # Path 3: Structural Refinement
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新結構重新生成"
64
118
  ```
65
119
 
66
120
  ---
67
121
 
68
- ## 透過變更偵測自動更新
122
+ ## 具備變更偵測的自動更新
69
123
 
70
- 當您執行 `aigne doc generate` 命令時,DocSmith 會分析您的程式碼庫,偵測自上次執行以來的任何變更,並僅重新生成受影響的文件。此過程可節省時間並減少不必要的 API 呼叫。
124
+ 當您執行 `aigne doc generate` 指令時,DocSmith 會先分析您的程式碼庫以偵測自上次生成以來的變更。接著,它只會重新生成受這些變更影響的文件。這種預設行為可以節省時間並減少 API 的使用。
71
125
 
72
126
  ```shell icon=lucide:terminal
73
127
  # DocSmith 將偵測變更並僅更新必要部分
@@ -78,7 +132,7 @@ aigne doc generate
78
132
 
79
133
  ### 強制完整重新生成
80
134
 
81
- 如果您需要從頭開始重新生成所有文件,忽略任何快取或先前的狀態,請使用 `--forceRegenerate` 標記。這在進行重大的設定變更後,或當您想確保一個完全全新的建置時非常有用。
135
+ 若要從頭開始重新生成所有文件,繞過快取和變更偵測,請使用 `--forceRegenerate` 旗標。當您進行了重大的設定變更或需要完全重建以確保一致性時,這項操作是必要的。
82
136
 
83
137
  ```shell icon=lucide:terminal
84
138
  # 從頭開始重新生成所有文件
@@ -87,52 +141,52 @@ aigne doc generate --forceRegenerate
87
141
 
88
142
  ---
89
143
 
90
- ## 優化單一文件
144
+ ## 完善個別文件
91
145
 
92
- 若要在沒有相應程式碼變更的情況下改善特定文件,`aigne doc update` 命令允許您提供針對內容優化的具體指示。
146
+ 若要在沒有相應程式碼變更的情況下改善特定文件的內容,請使用 `aigne doc update` 指令。此指令允許您提供針對性的指示以進行完善。
93
147
 
94
- 您可以用兩種方式使用此命令:互動式或直接透過命令列參數。
148
+ 這可以透過互動模式或透過命令列參數以非互動方式完成。
95
149
 
96
150
  ### 互動模式
97
151
 
98
- 若要獲得引導式體驗,請在不帶任何參數的情況下執行此命令。DocSmith 將會顯示一個選單,讓您選擇要更新的文件。選擇後,系統會提示您輸入回饋意見。
152
+ 若要進行引導式流程,請在不帶任何參數的情況下執行該指令。DocSmith 將會顯示一個選單,讓您選擇想要更新的文件。選擇後,系統將提示您輸入回饋。
99
153
 
100
154
  ```shell icon=lucide:terminal
101
- # 開始互動式更新流程
155
+ # 啟動互動式更新流程
102
156
  aigne doc update
103
157
  ```
104
158
 
105
- ![以互動方式選擇您想更新的文件。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
159
+ ![以互動方式選擇您希望更新的文件。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
106
160
 
107
161
  ### 直接透過命令列更新
108
162
 
109
- 為了更快速的工作流程或撰寫腳本,您可以使用標記直接指定文件和回饋意見。這允許進行精確、非互動式的更新。
163
+ 對於腳本化或更快速的工作流程,您可以使用旗標直接指定文件和回饋。這可以實現精確的非互動式更新。
110
164
 
111
165
  ```shell icon=lucide:terminal
112
- # 帶有回饋意見以更新特定文件
166
+ # 透過回饋更新特定文件
113
167
  aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
114
168
  ```
115
169
 
116
- `update` 命令的主要參數:
170
+ 以下是 `update` 指令的關鍵參數:
117
171
 
118
172
  | 參數 | 說明 |
119
- | ---------- | ------------------------------------------------------------------------------------------------ |
120
- | `--docs` | 您想更新的文件的路徑。您可以多次使用此標記進行批次更新。 |
173
+ | --- | --- |
174
+ | `--docs` | 要更新的文件的路徑。此旗標可多次使用以進行批次更新。 |
121
175
  | `--feedback` | 重新生成內容時要使用的具體指示。 |
122
176
 
123
177
  ---
124
178
 
125
179
  ## 優化整體結構
126
180
 
127
- 除了優化單一文件的內容,您還可以調整整體的文件結構。如果某個部分缺失或現有組織可以改進,您可以向 `generate` 命令提供回饋意見。
181
+ 除了完善個別文件內容外,您還可以調整整體的文件結構。如果現有組織不理想或缺少某個部分,您可以向 `generate` 指令提供回饋。
128
182
 
129
- 此命令指示 DocSmith 根據您的新輸入重新評估整個文件計畫。
183
+ 這會指示 DocSmith 根據您的輸入重新評估整個文件計畫。
130
184
 
131
185
  ```shell icon=lucide:terminal
132
- # 帶有特定回饋意見以重新生成文件結構
186
+ # 根據特定回饋重新生成文件結構
133
187
  aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
134
188
  ```
135
189
 
136
- 這種方法最適合對文件的目錄進行高層次的變更,而非逐行的內容編輯。
190
+ 此方法適用於對文件目錄進行高層次的變更,而非用於微小的內容編輯。
137
191
 
138
- 有了這些工具,您可以維護與您的專案一同演進的準確文件。一旦您的內容被優化,您就可以將其提供給全球的受眾。請在[翻譯文件](./features-translate-documentation.md)指南中了解如何操作。
192
+ 一旦您的內容完善後,下一步就是為全球受眾準備。有關說明,請參閱 [翻譯文件](./features-translate-documentation.md) 指南。
@@ -1,84 +1,138 @@
1
- # 更新与优化
1
+ # 更新与完善
2
2
 
3
- 让文档与不断演进的代码库保持同步是一项至关重要的任务。AIGNE DocSmith 提供了直接而灵活的方法来保持您的内容最新,无论是通过基于代码变更的自动更新,还是通过精确的、由反馈驱动的优化。
3
+ 让文档与不断演进的代码库保持同步是一个系统性的过程。AIGNE DocSmith 提供了直接而灵活的命令来保持内容最新,既可以通过基于代码变更的自动更新,也可以通过精确的、由反馈驱动的完善。
4
4
 
5
- 本指南将介绍如何:
5
+ 本指南涵盖了以下操作流程:
6
6
 
7
- - 在源代码变更时自动更新文档。
8
- - 使用有针对性的反馈重新生成特定文档。
7
+ - 在源代码修改时自动更新文档。
8
+ - 使用针对性的反馈重新生成特定文档。
9
9
  - 调整整体文档结构。
10
10
 
11
11
  ### 文档更新工作流
12
12
 
13
- 下图说明了更新文档可以采用的不同路径:
13
+ 下图展示了更新文档可用的不同工作流:
14
14
 
15
- ```d2 Update Workflows
15
+ ```d2 文档更新工作流
16
16
  direction: down
17
17
 
18
- Start: {
19
- shape: circle
20
- label: "开始"
18
+ developer: {
19
+ shape: c4-person
20
+ label: "开发者"
21
21
  }
22
22
 
23
- Code-Change: {
24
- label: "源代码或\n配置变更"
25
- shape: rectangle
23
+ codebase: {
24
+ shape: cylinder
25
+ label: "源代码"
26
26
  }
27
27
 
28
- Content-Tweak: {
29
- label: "需要内容\n改进?"
30
- shape: rectangle
28
+ updated-documentation: {
29
+ shape: cylinder
30
+ label: "更新后的\n文档"
31
31
  }
32
32
 
33
- Structure-Tweak: {
34
- label: "需要结构\n改进?"
33
+ workflows: {
34
+ label: "文档更新工作流"
35
35
  shape: rectangle
36
- }
37
-
38
- Start -> Code-Change
39
- Start -> Content-Tweak
40
- Start -> Structure-Tweak
41
-
42
- Code-Change -> Generate-Command: "aigne doc generate"
43
-
44
- Generate-Command -> Change-Detection: {
45
- label: "变更检测"
46
- shape: diamond
47
- }
48
- Change-Detection -> Auto-Regen: "重新生成\n受影响的文档"
49
-
50
- Content-Tweak -> Update-Command: "aigne doc update\n--feedback"
51
- Update-Command -> Manual-Regen: "重新生成\n特定文档"
52
-
53
- Structure-Tweak -> Generate-Feedback-Command: "aigne doc generate\n--feedback"
54
- Generate-Feedback-Command -> Replan: "重新规划文档\n结构"
55
36
 
56
- End: {
57
- shape: circle
58
- label: "文档已更新"
37
+ automatic-updates: {
38
+ label: "自动更新(代码驱动)"
39
+ shape: rectangle
40
+
41
+ cmd-generate: {
42
+ label: "aigne doc generate"
43
+ }
44
+
45
+ decision-force: {
46
+ label: "--forceRegenerate?"
47
+ shape: diamond
48
+ }
49
+
50
+ detect-changes: {
51
+ label: "检测变更"
52
+ }
53
+
54
+ regen-affected: {
55
+ label: "重新生成\n受影响的文档"
56
+ }
57
+
58
+ regen-all: {
59
+ label: "重新生成\n所有文档"
60
+ }
61
+ }
62
+
63
+ manual-refinements: {
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
+ }
59
95
  }
60
96
 
61
- Auto-Regen -> End
62
- Manual-Regen -> End
63
- Replan -> End
97
+ # --- 连接 ---
98
+
99
+ # 路径 1:自动更新
100
+ developer -> codebase: "1. 进行变更"
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新结构重新生成"
64
118
  ```
65
119
 
66
120
  ---
67
121
 
68
- ## 通过变更检测自动更新
122
+ ## 通过变更检测实现自动更新
69
123
 
70
- 当您运行 `aigne doc generate` 命令时,DocSmith 会分析您的代码库,检测自上次运行以来的任何变更,并仅重新生成受影响的文档。这个过程可以节省时间并减少不必要的 API 调用。
124
+ 当您执行 `aigne doc generate` 命令时,DocSmith 会首先分析您的代码库以检测自上次生成以来的变更。然后,它仅重新生成受这些变更影响的文档。这种默认行为可以节省时间并减少 API 使用量。
71
125
 
72
126
  ```shell icon=lucide:terminal
73
- # DocSmith 将检测变更并仅更新必要的内容
127
+ # DocSmith 将检测变更并仅更新必要的部分
74
128
  aigne doc generate
75
129
  ```
76
130
 
77
- ![DocSmith 会检测变更并仅重新生成所需的文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
131
+ ![DocSmith 检测变更并仅重新生成所需文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
78
132
 
79
133
  ### 强制完全重新生成
80
134
 
81
- 如果您需要从头开始重新生成所有文档,忽略任何缓存或先前的状态,请使用 `--forceRegenerate` 标志。这在进行重大配置更改后或当您希望确保完全重新构建时非常有用。
135
+ 要从头开始重新生成所有文档,绕过缓存和变更检测,请使用 `--forceRegenerate` 标志。当您进行了重大的配置更改或需要完全重建以确保一致性时,此操作是必需的。
82
136
 
83
137
  ```shell icon=lucide:terminal
84
138
  # 从头开始重新生成所有文档
@@ -87,52 +141,52 @@ aigne doc generate --forceRegenerate
87
141
 
88
142
  ---
89
143
 
90
- ## 优化单个文档
144
+ ## 完善单个文档
91
145
 
92
- 要在没有相应代码变更的情况下改进特定文档,`aigne doc update` 命令允许您为内容优化提供有针对性的指令。
146
+ 要在没有相应代码变更的情况下改进特定文档的内容,请使用 `aigne doc update` 命令。此命令允许您提供针对性的完善指令。
93
147
 
94
- 您可以通过两种方式使用此命令:交互式或直接通过命令行参数。
148
+ 这可以通过交互方式或通过命令行参数以非交互方式完成。
95
149
 
96
150
  ### 交互模式
97
151
 
98
- 要获得引导式体验,请在不带任何参数的情况下运行该命令。DocSmith 将会显示一个菜单,供您选择要更新的文档。选择后,系统将提示您输入反馈。
152
+ 要进行引导式流程,请不带参数运行该命令。DocSmith 将会显示一个菜单,供您选择要更新的文档。选择后,系统将提示您输入反馈。
99
153
 
100
154
  ```shell icon=lucide:terminal
101
- # 启动交互式更新过程
155
+ # 启动交互式更新流程
102
156
  aigne doc update
103
157
  ```
104
158
 
105
- ![交互式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
159
+ ![以交互方式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
106
160
 
107
161
  ### 直接通过命令行更新
108
162
 
109
- 为了实现更快的工作流或脚本编写,您可以使用标志直接指定文档和反馈。这允许进行精确的非交互式更新。
163
+ 对于脚本化或更快速的工作流,您可以使用标志直接指定文档和反馈。这样可以实现精确的非交互式更新。
110
164
 
111
165
  ```shell icon=lucide:terminal
112
166
  # 使用反馈更新特定文档
113
167
  aigne doc update --docs overview.md --feedback "在末尾添加更详细的常见问题解答部分。"
114
168
  ```
115
169
 
116
- `update` 命令的关键参数:
170
+ `update` 命令的主要参数如下:
117
171
 
118
- | 参数 | 描述 |
119
- | ---------- | ------------------------------------------------------------------------------------------------ |
120
- | `--docs` | 您想要更新的文档的路径。您可以多次使用此标志进行批量更新。 |
121
- | `--feedback` | 重新生成内容时使用的具体指令。 |
172
+ | 参数 | 描述 |
173
+ | --- | --- |
174
+ | `--docs` | 要更新的文档的路径。此标志可以多次使用以进行批量更新。 |
175
+ | `--feedback` | 重新生成内容时要使用的具体指令。 |
122
176
 
123
177
  ---
124
178
 
125
179
  ## 优化整体结构
126
180
 
127
- 除了优化单个文档的内容外,您还可以调整整体文档结构。如果缺少某个部分或现有组织结构可以改进,您可以向 `generate` 命令提供反馈。
181
+ 除了完善单个文档内容外,您还可以调整整体文档结构。如果现有组织结构不理想或缺少某个部分,您可以向 `generate` 命令提供反馈。
128
182
 
129
- 此命令指示 DocSmith 根据您的新输入重新评估整个文档计划。
183
+ 这会指示 DocSmith 根据您的输入重新评估整个文档计划。
130
184
 
131
185
  ```shell icon=lucide:terminal
132
186
  # 使用特定反馈重新生成文档结构
133
187
  aigne doc generate --feedback "删除‘关于’部分,并添加详细的‘API 参考’。"
134
188
  ```
135
189
 
136
- 这种方法最适合对文档目录进行高层级更改,而不是逐行编辑内容。
190
+ 此方法适用于文档目录的高级别更改,而非次要内容编辑。
137
191
 
138
- 借助这些工具,您可以维护与项目一同演进的准确文档。内容优化后,您可以将其提供给全球受众。在 [翻译文档](./features-translate-documentation.md) 指南中了解如何操作。
192
+ 内容完善后,下一步是为全球受众做准备。有关说明,请参阅 [翻译文档](./features-translate-documentation.md) 指南。
@@ -1,10 +1,10 @@
1
1
  # はじめに
2
2
 
3
- このガイドでは、AIGNE DocSmithをインストールし、プロジェクトを設定し、ソースコードから完全なドキュメント一式を生成するためのステップバイステップのウォークスルーを提供します。
3
+ このガイドでは、AIGNE DocSmithをインストールし、プロジェクトを設定し、ソースコードから完全なドキュメントセットを生成するための手順をステップバイステップで説明します。
4
4
 
5
- ## ステップ1: 前提条件
5
+ ## ステップ1:前提条件
6
6
 
7
- 始める前に、システムにNode.jsとそのパッケージマネージャーであるnpmがインストールされていることを確認してください。DocSmithは、Node.js環境で実行されるコマンドラインツールです。
7
+ 始める前に、お使いのシステムにNode.jsとそのパッケージマネージャーであるnpmがインストールされていることを確認してください。DocSmithNode.js環境で動作するコマンドラインツールです。
8
8
 
9
9
  ### Node.jsのインストール
10
10
 
@@ -16,13 +16,13 @@
16
16
 
17
17
  **macOS**
18
18
 
19
- 推奨される方法は[Homebrew](https://brew.sh/)を使用することです:
19
+ 推奨される方法は[Homebrew](https://brew.sh/)を使用することです:
20
20
 
21
21
  ```bash Terminal icon=lucide:apple
22
- # Install Homebrew if you don't have it
22
+ # Homebrewがインストールされていない場合はインストールします
23
23
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
24
24
 
25
- # Install Node.js
25
+ # Node.jsをインストールします
26
26
  brew install node
27
27
  ```
28
28
 
@@ -30,7 +30,7 @@ brew install node
30
30
 
31
31
  **Linux**
32
32
 
33
- Ubuntu/Debianベースのシステムの場合:
33
+ Ubuntu/Debianベースのシステムの場合:
34
34
 
35
35
  ```bash Terminal icon=lucide:laptop
36
36
  sudo apt update
@@ -38,7 +38,7 @@ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
38
38
  sudo apt-get install -y nodejs
39
39
  ```
40
40
 
41
- CentOS/RHEL/Fedoraベースのシステムの場合:
41
+ CentOS/RHEL/Fedoraベースのシステムの場合:
42
42
 
43
43
  ```bash Terminal icon=lucide:laptop
44
44
  curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
@@ -47,32 +47,32 @@ sudo yum install nodejs
47
47
 
48
48
  ### 確認
49
49
 
50
- インストール後、ターミナルでこれらのコマンドを実行して、Node.jsとnpmが利用可能であることを確認します:
50
+ インストール後、ターミナルで次のコマンドを実行して、Node.jsとnpmが利用可能であることを確認します:
51
51
 
52
52
  ```bash Terminal
53
53
  node --version
54
54
  npm --version
55
55
  ```
56
56
 
57
- ## ステップ2: AIGNE CLIのインストール
57
+ ## ステップ2AIGNE CLIのインストール
58
58
 
59
- The DocSmithツールは、AIGNEコマンドラインインターフェース(CLI)に含まれています。npmを使用してAIGNE CLIの最新バージョンをグローバルにインストールします:
59
+ DocSmithツールは、AIGNEコマンドラインインターフェース(CLI)に含まれています。npmを使用してAIGNE CLIの最新バージョンをグローバルにインストールします:
60
60
 
61
61
  ```bash Terminal icon=logos:npm
62
62
  npm i -g @aigne/cli
63
63
  ```
64
64
 
65
- インストールが完了したら、ドキュメンテーションツールのヘルプコマンドを実行して確認します:
65
+ インストールが完了したら、ドキュメンテーションツールのヘルプコマンドを実行して確認します:
66
66
 
67
67
  ```bash Terminal
68
68
  aigne doc -h
69
69
  ```
70
70
 
71
- このコマンドはDocSmithのヘルプメニューを表示し、使用準備が整っていることを確認します。
71
+ このコマンドを実行すると、DocSmithのヘルプメニューが表示され、使用準備が整ったことを確認できます。
72
72
 
73
- ## ステップ3: ドキュメントの生成
73
+ ## ステップ3:ドキュメントの生成
74
74
 
75
- CLIがインストールされたら、単一のコマンドでドキュメントを生成できます。ターミナルでプロジェクトのルートディレクトリに移動し、次を実行します:
75
+ CLIがインストールされたので、1つのコマンドでドキュメントを生成できます。ターミナルでプロジェクトのルートディレクトリに移動し、次を実行します:
76
76
 
77
77
  ```bash Terminal icon=lucide:sparkles
78
78
  aigne doc generate
@@ -80,11 +80,11 @@ aigne doc generate
80
80
 
81
81
  ### 自動設定
82
82
 
83
- プロジェクトでこのコマンドを初めて実行すると、DocSmithは設定が存在しないことを検出し、対話式のセットアップウィザードを自動的に起動します。
83
+ プロジェクトでこのコマンドを初めて実行すると、DocSmithは設定が存在しないことを検出し、自動的に対話式のセットアップウィザードを起動します。
84
84
 
85
85
  ![generateコマンドを実行するとセットアップウィザードが開始されます](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
86
86
 
87
- ドキュメントの特性を定義するための一連の質問が表示されます。これには以下が含まれます:
87
+ ドキュメントの特性を定義するための一連の質問が表示されます。これには以下が含まれます:
88
88
 
89
89
  - 主な目的とスタイル。
90
90
  - 対象読者。
@@ -94,21 +94,21 @@ aigne doc generate
94
94
 
95
95
  ![プロンプトに答えてプロジェクトのセットアップを完了します](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
96
96
 
97
- 設定が完了すると、DocSmithはソースコードの分析、ドキュメント構造の計画、コンテンツの生成に進みます。
97
+ 設定が完了すると、DocSmithはソースコードの分析、ドキュメント構造の計画、そしてコンテンツの生成に進みます。
98
98
 
99
- ![DocSmithが構造を計画し、ドキュメントを生成しています](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
99
+ ![DocSmithが構造を計画し、ドキュメントを生成している様子](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
100
100
 
101
- ## ステップ4: 出力の確認
101
+ ## ステップ4:出力の確認
102
102
 
103
103
  生成プロセスが終了すると、ターミナルに確認メッセージが表示されます。
104
104
 
105
105
  ![ドキュメント生成成功のメッセージ](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
106
106
 
107
- 新しいドキュメントは、セットアッププロセス中に指定した出力ディレクトリで利用可能になりました。デフォルトの場所は `.aigne/doc-smith/docs` です。
107
+ 新しいドキュメントは、セットアッププロセス中に指定した出力ディレクトリで利用可能になります。デフォルトの場所は`.aigne/doc-smith/docs`です。
108
108
 
109
109
  ## 次のステップ
110
110
 
111
- 最初のドキュメントセットを生成したので、他の機能を試すことができます:
111
+ 最初のドキュメントセットを生成したので、他の機能を試すことができます:
112
112
 
113
113
  <x-cards>
114
114
  <x-card data-title="コア機能" data-icon="lucide:box" data-href="/features">
@@ -94,7 +94,7 @@ You will be prompted with a series of questions to define the documentation's ch
94
94
 
95
95
  ![Answer the prompts to complete the project setup](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
96
96
 
97
- Once the configuration is complete, DocSmith will proceed to analyze your source code, plan the document structure, and generate the content.
97
+ Once the configuration is complete, DocSmith will proceed to analyze your source code, plan the documentation structure, and generate the content.
98
98
 
99
99
  ![DocSmith planning the structure and generating documents](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
100
100