@aigne/doc-smith 0.8.11-beta → 0.8.11-beta.2
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 +3 -3
- package/.aigne/doc-smith/upload-cache.yaml +252 -0
- package/.github/workflows/publish-docs.yml +67 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +22 -0
- package/README.md +45 -115
- package/agents/clear/choose-contents.mjs +170 -0
- package/agents/clear/clear-auth-tokens.mjs +111 -0
- package/agents/clear/clear-document-config.mjs +39 -0
- package/agents/clear/clear-document-structure.mjs +106 -0
- package/agents/clear/clear-generated-docs.mjs +51 -0
- package/agents/clear/index.yaml +23 -0
- package/agents/evaluate/code-snippet.mjs +93 -0
- package/agents/evaluate/document-structure.yaml +70 -0
- package/agents/evaluate/document.yaml +79 -0
- package/agents/evaluate/generate-report.mjs +78 -0
- package/agents/evaluate/index.yaml +39 -0
- package/agents/generate/document-structure-tools/add-document.mjs +56 -0
- package/agents/generate/document-structure-tools/delete-document.mjs +49 -0
- package/agents/generate/document-structure-tools/move-document.mjs +82 -0
- package/agents/generate/document-structure-tools/update-document.mjs +50 -0
- package/agents/generate/generate-structure.yaml +1 -1
- package/agents/generate/update-document-structure.yaml +42 -0
- package/agents/generate/user-review-document-structure.mjs +6 -4
- package/agents/init/index.mjs +1 -1
- package/agents/publish/publish-docs.mjs +12 -3
- package/agents/translate/choose-language.mjs +1 -1
- package/agents/update/batch-update-document.yaml +7 -0
- package/agents/update/check-update-is-single.mjs +38 -0
- package/agents/update/document-tools/update-document-content.mjs +293 -0
- package/agents/update/index.yaml +4 -10
- package/agents/update/update-document-detail.yaml +52 -0
- package/agents/update/update-single-document.yaml +15 -0
- package/agents/update/user-review-document.mjs +248 -0
- package/agents/utils/choose-docs.mjs +4 -2
- package/agents/utils/format-document-structure.mjs +12 -2
- package/agents/utils/load-document-all-content.mjs +84 -0
- package/agents/utils/load-sources.mjs +4 -1
- package/aigne.yaml +59 -20
- package/assets/report-template/report.html +198 -0
- package/biome.json +14 -2
- package/docs/advanced-how-it-works.ja.md +101 -0
- package/docs/advanced-how-it-works.zh-TW.md +101 -0
- package/docs/advanced-how-it-works.zh.md +20 -20
- package/docs/advanced-quality-assurance.ja.md +96 -0
- package/docs/advanced-quality-assurance.zh-TW.md +96 -0
- package/docs/advanced-quality-assurance.zh.md +18 -18
- package/docs/advanced.ja.md +16 -0
- package/docs/advanced.zh-TW.md +16 -0
- package/docs/advanced.zh.md +4 -4
- package/docs/changelog.ja.md +309 -0
- package/docs/changelog.zh-TW.md +309 -0
- package/docs/changelog.zh.md +23 -23
- package/docs/cli-reference.ja.md +210 -0
- package/docs/cli-reference.zh-TW.md +210 -0
- package/docs/cli-reference.zh.md +21 -21
- package/docs/configuration-interactive-setup.ja.md +135 -0
- package/docs/configuration-interactive-setup.zh-TW.md +135 -0
- package/docs/configuration-interactive-setup.zh.md +29 -29
- package/docs/configuration-language-support.ja.md +94 -0
- package/docs/configuration-language-support.zh-TW.md +94 -0
- package/docs/configuration-language-support.zh.md +13 -13
- package/docs/configuration-llm-setup.ja.md +54 -0
- package/docs/configuration-llm-setup.zh-TW.md +54 -0
- package/docs/configuration-llm-setup.zh.md +12 -12
- package/docs/configuration-preferences.ja.md +129 -0
- package/docs/configuration-preferences.zh-TW.md +129 -0
- package/docs/configuration-preferences.zh.md +36 -36
- package/docs/configuration.ja.md +172 -0
- package/docs/configuration.zh-TW.md +172 -0
- package/docs/configuration.zh.md +49 -49
- package/docs/features-generate-documentation.ja.md +101 -0
- package/docs/features-generate-documentation.zh-TW.md +101 -0
- package/docs/features-generate-documentation.zh.md +17 -17
- package/docs/features-publish-your-docs.ja.md +107 -0
- package/docs/features-publish-your-docs.zh-TW.md +107 -0
- package/docs/features-publish-your-docs.zh.md +22 -22
- package/docs/features-translate-documentation.ja.md +79 -0
- package/docs/features-translate-documentation.zh-TW.md +79 -0
- package/docs/features-translate-documentation.zh.md +12 -12
- package/docs/features-update-and-refine.ja.md +138 -0
- package/docs/features-update-and-refine.zh-TW.md +138 -0
- package/docs/features-update-and-refine.zh.md +21 -21
- package/docs/features.ja.md +52 -0
- package/docs/features.zh-TW.md +52 -0
- package/docs/features.zh.md +8 -8
- package/docs/getting-started.ja.md +123 -0
- package/docs/getting-started.zh-TW.md +123 -0
- package/docs/getting-started.zh.md +24 -24
- package/docs/overview.ja.md +30 -0
- package/docs/overview.zh-TW.md +30 -0
- package/docs/overview.zh.md +8 -8
- package/package.json +19 -11
- package/prompts/common/document/content-rules-core.md +19 -0
- package/prompts/common/document/media-handling-rules.md +9 -0
- package/prompts/common/document/role-and-personality.md +15 -0
- package/prompts/common/document/user-preferences.md +9 -0
- package/prompts/common/document-structure/conflict-resolution-guidance.md +16 -0
- package/prompts/common/document-structure/document-structure-rules.md +45 -0
- package/prompts/common/document-structure/glossary.md +7 -0
- package/prompts/common/document-structure/intj-traits.md +5 -0
- package/prompts/common/document-structure/output-constraints.md +9 -0
- package/prompts/common/document-structure/user-locale-rules.md +10 -0
- package/prompts/common/document-structure/user-preferences.md +9 -0
- package/prompts/detail/custom/custom-components.md +9 -1
- package/prompts/detail/document-rules.md +6 -6
- package/prompts/detail/generate-document.md +5 -45
- package/prompts/detail/update-document.md +145 -0
- package/prompts/evaluate/document-structure.md +94 -0
- package/prompts/evaluate/document.md +149 -0
- package/prompts/structure/document-rules.md +1 -1
- package/prompts/structure/generate-structure-system.md +74 -0
- package/prompts/structure/generate-structure-user.md +41 -0
- package/prompts/structure/update-document-structure.md +118 -0
- package/prompts/translate/translate-document.md +1 -1
- package/prompts/utils/feedback-refiner.md +3 -3
- package/release-please-config.json +1 -7
- package/tests/agents/clear/choose-contents.test.mjs +280 -0
- package/tests/agents/clear/clear-auth-tokens.test.mjs +268 -0
- package/tests/agents/clear/clear-document-config.test.mjs +167 -0
- package/tests/agents/clear/clear-document-structure.test.mjs +374 -0
- package/tests/agents/clear/clear-generated-docs.test.mjs +222 -0
- package/tests/agents/evaluate/code-snippet.test.mjs +163 -0
- package/tests/agents/evaluate/fixtures/api-services.md +87 -0
- package/tests/agents/evaluate/fixtures/js-sdk.md +94 -0
- package/tests/agents/evaluate/generate-report.test.mjs +312 -0
- package/tests/agents/generate/check-document-structure.test.mjs +0 -6
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +449 -0
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +410 -0
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +476 -0
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +548 -0
- package/tests/agents/generate/generate-structure.test.mjs +0 -6
- package/tests/agents/generate/user-review-document-structure.test.mjs +9 -9
- package/tests/agents/publish/publish-docs.test.mjs +2 -2
- package/tests/agents/update/check-update-is-single.test.mjs +300 -0
- package/tests/agents/update/document-tools/update-document-content.test.mjs +326 -0
- package/tests/agents/update/user-review-document.test.mjs +561 -0
- package/tests/agents/utils/format-document-structure.test.mjs +100 -0
- package/tests/utils/auth-utils.test.mjs +239 -1
- package/tests/utils/blocklet.test.mjs +9 -7
- package/tests/utils/constants.test.mjs +1 -1
- package/tests/utils/d2-utils.test.mjs +1 -1
- package/tests/utils/deploy.test.mjs +310 -366
- package/tests/utils/kroki-utils.test.mjs +2 -15
- package/tests/utils/linter/fixtures/css/keyword-error.css +1 -0
- package/tests/utils/linter/fixtures/css/missing-semicolon.css +1 -0
- package/tests/utils/linter/fixtures/css/syntax-error.css +1 -0
- package/tests/utils/linter/fixtures/css/undeclare-variable.css +1 -0
- package/tests/utils/linter/fixtures/css/unused-variable.css +2 -0
- package/tests/utils/linter/fixtures/css/valid-code.css +1 -0
- package/tests/utils/linter/fixtures/dockerfile/keyword-error.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/missing-semicolon.dockerfile +2 -0
- package/tests/utils/linter/fixtures/dockerfile/syntax-error.dockerfile +2 -0
- package/tests/utils/linter/fixtures/dockerfile/undeclare-variable.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/unused-variable.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/valid-code.dockerfile +2 -0
- package/tests/utils/linter/fixtures/go/keyword-error.go +5 -0
- package/tests/utils/linter/fixtures/go/missing-semicolon.go +5 -0
- package/tests/utils/linter/fixtures/go/syntax-error.go +6 -0
- package/tests/utils/linter/fixtures/go/undeclare-variable.go +5 -0
- package/tests/utils/linter/fixtures/go/unused-variable.go +5 -0
- package/tests/utils/linter/fixtures/go/valid-code.go +7 -0
- package/tests/utils/linter/fixtures/js/keyword-error.js +3 -0
- package/tests/utils/linter/fixtures/js/missing-semicolon.js +6 -0
- package/tests/utils/linter/fixtures/js/syntax-error.js +4 -0
- package/tests/utils/linter/fixtures/js/undeclare-variable.js +3 -0
- package/tests/utils/linter/fixtures/js/unused-variable.js +7 -0
- package/tests/utils/linter/fixtures/js/valid-code.js +15 -0
- package/tests/utils/linter/fixtures/json/keyword-error.json +1 -0
- package/tests/utils/linter/fixtures/json/missing-semicolon.json +1 -0
- package/tests/utils/linter/fixtures/json/syntax-error.json +1 -0
- package/tests/utils/linter/fixtures/json/undeclare-variable.json +1 -0
- package/tests/utils/linter/fixtures/json/unused-variable.json +1 -0
- package/tests/utils/linter/fixtures/json/valid-code.json +1 -0
- package/tests/utils/linter/fixtures/jsx/keyword-error.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/missing-semicolon.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/syntax-error.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/undeclare-variable.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/unused-variable.jsx +4 -0
- package/tests/utils/linter/fixtures/jsx/valid-code.jsx +5 -0
- package/tests/utils/linter/fixtures/python/keyword-error.py +3 -0
- package/tests/utils/linter/fixtures/python/missing-semicolon.py +2 -0
- package/tests/utils/linter/fixtures/python/syntax-error.py +3 -0
- package/tests/utils/linter/fixtures/python/undeclare-variable.py +3 -0
- package/tests/utils/linter/fixtures/python/unused-variable.py +6 -0
- package/tests/utils/linter/fixtures/python/valid-code.py +12 -0
- package/tests/utils/linter/fixtures/ruby/keyword-error.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/missing-semicolon.rb +1 -0
- package/tests/utils/linter/fixtures/ruby/syntax-error.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/undeclare-variable.rb +1 -0
- package/tests/utils/linter/fixtures/ruby/unused-variable.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/valid-code.rb +1 -0
- package/tests/utils/linter/fixtures/sass/keyword-error.sass +2 -0
- package/tests/utils/linter/fixtures/sass/missing-semicolon.sass +3 -0
- package/tests/utils/linter/fixtures/sass/syntax-error.sass +3 -0
- package/tests/utils/linter/fixtures/sass/undeclare-variable.sass +2 -0
- package/tests/utils/linter/fixtures/sass/unused-variable.sass +4 -0
- package/tests/utils/linter/fixtures/sass/valid-code.sass +2 -0
- package/tests/utils/linter/fixtures/scss/keyword-error.scss +1 -0
- package/tests/utils/linter/fixtures/scss/missing-semicolon.scss +1 -0
- package/tests/utils/linter/fixtures/scss/syntax-error.scss +1 -0
- package/tests/utils/linter/fixtures/scss/undeclare-variable.scss +1 -0
- package/tests/utils/linter/fixtures/scss/unused-variable.scss +2 -0
- package/tests/utils/linter/fixtures/scss/valid-code.scss +1 -0
- package/tests/utils/linter/fixtures/shell/keyword-error.sh +5 -0
- package/tests/utils/linter/fixtures/shell/missing-semicolon.sh +3 -0
- package/tests/utils/linter/fixtures/shell/syntax-error.sh +4 -0
- package/tests/utils/linter/fixtures/shell/undeclare-variable.sh +3 -0
- package/tests/utils/linter/fixtures/shell/unused-variable.sh +4 -0
- package/tests/utils/linter/fixtures/shell/valid-code.sh +3 -0
- package/tests/utils/linter/fixtures/ts/keyword-error.ts +1 -0
- package/tests/utils/linter/fixtures/ts/missing-semicolon.ts +1 -0
- package/tests/utils/linter/fixtures/ts/syntax-error.ts +1 -0
- package/tests/utils/linter/fixtures/ts/undeclare-variable.ts +1 -0
- package/tests/utils/linter/fixtures/ts/unused-variable.ts +3 -0
- package/tests/utils/linter/fixtures/ts/valid-code.ts +3 -0
- package/tests/utils/linter/fixtures/tsx/keyword-error.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/missing-semicolon.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/syntax-error.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/undeclare-variable.tsx +6 -0
- package/tests/utils/linter/fixtures/tsx/unused-variable.tsx +6 -0
- package/tests/utils/linter/fixtures/tsx/valid-code.tsx +5 -0
- package/tests/utils/linter/fixtures/vue/keyword-error.vue +6 -0
- package/tests/utils/linter/fixtures/vue/missing-semicolon.vue +6 -0
- package/tests/utils/linter/fixtures/vue/syntax-error.vue +6 -0
- package/tests/utils/linter/fixtures/vue/undeclare-variable.vue +6 -0
- package/tests/utils/linter/fixtures/vue/unused-variable.vue +7 -0
- package/tests/utils/linter/fixtures/vue/valid-code.vue +6 -0
- package/tests/utils/linter/fixtures/yaml/keyword-error.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/missing-semicolon.yml +2 -0
- package/tests/utils/linter/fixtures/yaml/syntax-error.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/undeclare-variable.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/unused-variable.yml +2 -0
- package/tests/utils/linter/fixtures/yaml/valid-code.yml +3 -0
- package/tests/utils/linter/index.test.mjs +440 -0
- package/tests/utils/linter/scan-results.mjs +42 -0
- package/tests/utils/markdown/index.test.mjs +478 -0
- package/tests/utils/mermaid-validator.test.mjs +2 -2
- package/tests/utils/utils.test.mjs +3 -1
- package/types/document-schema.mjs +54 -0
- package/types/document-structure-schema.mjs +244 -0
- package/utils/auth-utils.mjs +131 -6
- package/utils/conflict-detector.mjs +5 -1
- package/utils/{constants.mjs → constants/index.mjs} +109 -0
- package/utils/constants/linter.mjs +102 -0
- package/utils/d2-utils.mjs +2 -4
- package/utils/debug.mjs +3 -0
- package/utils/deploy.mjs +81 -385
- package/utils/evaluate/report-utils.mjs +131 -0
- package/utils/file-utils.mjs +36 -1
- package/utils/kroki-utils.mjs +1 -1
- package/utils/linter/index.mjs +50 -0
- package/utils/markdown/index.mjs +26 -0
- package/utils/markdown-checker.mjs +1 -1
- package/utils/utils.mjs +19 -7
- package/prompts/structure/generate-structure.md +0 -161
package/docs/cli-reference.zh.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# CLI 命令参考
|
|
2
2
|
|
|
3
|
-
本指南为所有可用的 `aigne doc`
|
|
3
|
+
本指南为所有可用的 `aigne doc` 子命令、其参数和选项提供了参考。它旨在帮助用户充分利用命令行界面。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
通用语法是:
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
aigne doc <command> [options]
|
|
@@ -10,7 +10,7 @@ aigne doc <command> [options]
|
|
|
10
10
|
|
|
11
11
|
### 命令工作流
|
|
12
12
|
|
|
13
|
-
下图展示了使用 DocSmith CLI 命令创建和维护文档的典型生命周期:
|
|
13
|
+
下图展示了使用 DocSmith 的 CLI 命令创建和维护文档的典型生命周期:
|
|
14
14
|
|
|
15
15
|
```d2
|
|
16
16
|
direction: down
|
|
@@ -69,11 +69,11 @@ publish -> End
|
|
|
69
69
|
|
|
70
70
|
## `aigne doc generate`
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
分析您的源代码,并根据您的配置生成一套完整的文档。如果找不到配置,它会自动启动交互式设置向导。
|
|
73
73
|
|
|
74
74
|
### 选项
|
|
75
75
|
|
|
76
|
-
|
|
|
76
|
+
| 选项 | 类型 | 描述 |
|
|
77
77
|
| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
|
|
78
78
|
| `--feedback` | string | 提供反馈以调整和优化整体文档结构。 |
|
|
79
79
|
| `--forceRegenerate` | boolean | 丢弃现有内容并从头开始重新生成所有文档。 |
|
|
@@ -96,10 +96,10 @@ aigne doc generate --forceRegenerate
|
|
|
96
96
|
**通过反馈优化文档结构:**
|
|
97
97
|
|
|
98
98
|
```bash
|
|
99
|
-
aigne doc generate --feedback "
|
|
99
|
+
aigne doc generate --feedback "为 API 示例添加一个新部分,并删除‘关于’页面。"
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
**使用 AIGNE Hub
|
|
102
|
+
**使用 AIGNE Hub 中的特定模型进行生成:**
|
|
103
103
|
|
|
104
104
|
```bash
|
|
105
105
|
aigne doc generate --model google:gemini-1.5-flash
|
|
@@ -109,11 +109,11 @@ aigne doc generate --model google:gemini-1.5-flash
|
|
|
109
109
|
|
|
110
110
|
## `aigne doc update`
|
|
111
111
|
|
|
112
|
-
|
|
112
|
+
优化并重新生成特定文档。您可以以交互方式运行它来选择文档,或使用选项直接指定文档。这对于根据反馈进行有针对性的改进非常有用,而无需重新生成整个项目。
|
|
113
113
|
|
|
114
114
|
### 选项
|
|
115
115
|
|
|
116
|
-
|
|
|
116
|
+
| 选项 | 类型 | 描述 |
|
|
117
117
|
| ---------- | ----- | ------------------------------------------------------------------------------------------- |
|
|
118
118
|
| `--docs` | array | 要重新生成的文档路径列表。可多次使用。 |
|
|
119
119
|
| `--feedback` | string | 提供具体反馈以改进所选文档的内容。 |
|
|
@@ -129,23 +129,23 @@ aigne doc update
|
|
|
129
129
|
**使用有针对性的反馈更新特定文档:**
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
aigne doc update --docs overview.md --feedback "
|
|
132
|
+
aigne doc update --docs overview.md --feedback "添加更详细的常见问题解答条目"
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
---
|
|
136
136
|
|
|
137
137
|
## `aigne doc translate`
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
将现有文档翻译成一种或多种语言。可以以交互方式运行以选择文档和语言,也可以通过将它们指定为参数以非交互方式运行。
|
|
140
140
|
|
|
141
141
|
### 选项
|
|
142
142
|
|
|
143
|
-
|
|
|
143
|
+
| 选项 | 类型 | 描述 |
|
|
144
144
|
| ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
|
|
145
145
|
| `--docs` | array | 要翻译的文档路径列表。可多次使用。 |
|
|
146
|
-
| `--langs` | array |
|
|
146
|
+
| `--langs` | array | 目标语言代码列表(例如 `zh`、`ja`)。可多次使用。 |
|
|
147
147
|
| `--feedback` | string | 提供反馈以提高翻译质量。 |
|
|
148
|
-
| `--glossary` | string |
|
|
148
|
+
| `--glossary` | string | 术语表文件的路径,以确保跨语言术语的一致性。使用 `@path/to/glossary.md`。 |
|
|
149
149
|
|
|
150
150
|
### 使用示例
|
|
151
151
|
|
|
@@ -161,23 +161,23 @@ aigne doc translate
|
|
|
161
161
|
aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
|
|
162
162
|
```
|
|
163
163
|
|
|
164
|
-
|
|
164
|
+
**使用术语表和反馈进行翻译以获得更好的质量:**
|
|
165
165
|
|
|
166
166
|
```bash
|
|
167
|
-
aigne doc translate --glossary @glossary.md --feedback "
|
|
167
|
+
aigne doc translate --glossary @glossary.md --feedback "始终如一地使用技术术语"
|
|
168
168
|
```
|
|
169
169
|
|
|
170
170
|
---
|
|
171
171
|
|
|
172
172
|
## `aigne doc publish`
|
|
173
173
|
|
|
174
|
-
将您生成的文档发布到 Discuss Kit 平台。您可以发布到官方的 AIGNE DocSmith
|
|
174
|
+
将您生成的文档发布到 Discuss Kit 平台。您可以发布到官方的 AIGNE DocSmith 平台,也可以发布到您自己托管的实例。
|
|
175
175
|
|
|
176
176
|
### 选项
|
|
177
177
|
|
|
178
|
-
|
|
|
178
|
+
| 选项 | 类型 | 描述 |
|
|
179
179
|
| ---------- | ------ | ---------------------------------------------------------------------------------------------------- |
|
|
180
|
-
| `--appUrl` | string |
|
|
180
|
+
| `--appUrl` | string | 您自托管的 Discuss Kit 实例的 URL。如果未提供,该命令将以交互方式运行。 |
|
|
181
181
|
|
|
182
182
|
### 使用示例
|
|
183
183
|
|
|
@@ -187,7 +187,7 @@ aigne doc translate --glossary @glossary.md --feedback "Use technical terminolog
|
|
|
187
187
|
aigne doc publish
|
|
188
188
|
```
|
|
189
189
|
|
|
190
|
-
|
|
190
|
+
**直接发布到自托管实例:**
|
|
191
191
|
|
|
192
192
|
```bash
|
|
193
193
|
aigne doc publish --appUrl https://your-discuss-kit-instance.com
|
|
@@ -207,4 +207,4 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
|
|
|
207
207
|
aigne doc init
|
|
208
208
|
```
|
|
209
209
|
|
|
210
|
-
有关如何根据您的需求定制 DocSmith 的更多详细信息,请参阅[配置指南](./configuration.md)。
|
|
210
|
+
有关如何根据您的需求定制 DocSmith 的更多详细信息,请参阅[配置指南](./configuration.md)。
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# 対話型セットアップ
|
|
2
|
+
|
|
3
|
+
AIGNE DocSmithには、プロジェクト設定を効率化するための対話型セットアップウィザードが含まれており、`aigne doc init`コマンドで起動します。このガイド付きプロセスでは、ドキュメントの目標に関する一連の質問が行われ、その回答から`config.yaml`ファイルが生成されます。これは、設定エラーを防ぎ、入力に基づいて具体的な推奨事項を提供するため、新しいドキュメントプロジェクトを開始する際に推奨される方法です。
|
|
4
|
+
|
|
5
|
+
## ウィザードの実行
|
|
6
|
+
|
|
7
|
+
プロセスを開始するには、プロジェクトのルートディレクトリで次のコマンドを実行します。
|
|
8
|
+
|
|
9
|
+
```bash aigne doc init icon=lucide:sparkles
|
|
10
|
+
npx aigne doc init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
ウィザードは、ドキュメントを設定するための8ステップのプロセスを案内します。
|
|
14
|
+
|
|
15
|
+
## ガイド付きプロセス
|
|
16
|
+
|
|
17
|
+
ウィザードは、以下の主要な設定詳細を尋ねます。
|
|
18
|
+
|
|
19
|
+
1. **主な目標**: 読者の主な目的を定義します(例:入門、回答の検索)。
|
|
20
|
+
2. **対象読者**: ドキュメントの主な読者を指定します(例:非技術的なエンドユーザー、開発者)。
|
|
21
|
+
3. **読者の知識レベル**: 対象読者の典型的な初期知識を評価します。
|
|
22
|
+
4. **ドキュメントの深さ**: コンテンツの詳細レベルと範囲を決定します。
|
|
23
|
+
5. **主な言語**: ドキュメントの主要言語を設定します。
|
|
24
|
+
6. **翻訳言語**: 翻訳のための追加言語を選択します。
|
|
25
|
+
7. **出力ディレクトリ**: 生成されたドキュメントファイルの場所を指定します。
|
|
26
|
+
8. **ソースコードのパス**: globパターンをサポートし、分析対象のファイルとディレクトリを定義します。
|
|
27
|
+
|
|
28
|
+
## 設定支援
|
|
29
|
+
|
|
30
|
+
ウィザードは、一貫性のある効果的な設定を作成するために、事前定義された一連のルールを使用します。
|
|
31
|
+
|
|
32
|
+
```d2
|
|
33
|
+
direction: down
|
|
34
|
+
|
|
35
|
+
User-Selections: {
|
|
36
|
+
label: "1. User provides input\n(Purpose, Audience, etc.)"
|
|
37
|
+
shape: rectangle
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
Wizard-Engine: {
|
|
41
|
+
label: "2. Wizard's Rule Engine"
|
|
42
|
+
shape: rectangle
|
|
43
|
+
grid-columns: 2
|
|
44
|
+
|
|
45
|
+
Filtering: {
|
|
46
|
+
label: "Option Filtering\n(Prevents incompatible selections)"
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
Conflict-Detection: {
|
|
50
|
+
label: "Conflict Detection\n(Identifies complex needs)"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
Guided-Experience: {
|
|
55
|
+
label: "3. Guided Experience"
|
|
56
|
+
shape: rectangle
|
|
57
|
+
content: "User sees simplified, relevant options"
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
Final-Config: {
|
|
61
|
+
label: "4. Final Configuration"
|
|
62
|
+
content: "config.yaml is generated with\nconflict resolution strategies"
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
User-Selections -> Wizard-Engine
|
|
66
|
+
Wizard-Engine.Filtering -> Guided-Experience
|
|
67
|
+
Wizard-Engine.Conflict-Detection -> Final-Config
|
|
68
|
+
Guided-Experience -> User-Selections: "Refines"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### デフォルトの提案とオプションのフィルタリング
|
|
72
|
+
|
|
73
|
+
選択を行うと、ウィザードはデフォルトを提供し、後続のオプションをフィルタリングして、論理的な設定に導きます。これは、質問間の競合ルールセットに基づいています。
|
|
74
|
+
|
|
75
|
+
- **デフォルトの提案**: 主な目標として「すぐに始める」を選択すると、ウィザードは読者の知識レベルとして「完全な初心者」を推奨します。
|
|
76
|
+
- **リアルタイムフィルタリング**: 対象読者が「エンドユーザー(非技術的)」の場合、ウィザードは「専門家」の知識レベルを非表示にします。このルールの理由は、非技術的なユーザーは通常、経験豊富な技術ユーザーではないため、互換性のない選択を防ぐためです。
|
|
77
|
+
|
|
78
|
+
### 競合の検出と解決
|
|
79
|
+
|
|
80
|
+
場合によっては、非技術的な**エンドユーザー**と専門家の**開発者**の両方向けにドキュメントを作成するなど、効果的なドキュメント構造を必要とする複数の目標や対象者がいることがあります。ウィザードはこれらを「解決可能な競合」として識別します。
|
|
81
|
+
|
|
82
|
+
次に、これらのニーズにドキュメント構造内で対応するための戦略を策定します。エンドユーザー対開発者の例では、解決戦略として別々のユーザーパスを作成します。
|
|
83
|
+
|
|
84
|
+
- **ユーザーガイドパス**: 平易な言葉を使用し、UIの操作に焦点を当て、ビジネスの成果を志向します。
|
|
85
|
+
- **開発者ガイドパス**: コード中心で技術的に正確であり、SDKの例や設定スニペットを含みます。
|
|
86
|
+
|
|
87
|
+
このアプローチにより、最終的なドキュメントは、単一の混乱したコンテンツの混合物を作成するのではなく、複数の対象者に効果的に対応できるように構成されます。
|
|
88
|
+
|
|
89
|
+
## 生成される出力
|
|
90
|
+
|
|
91
|
+
ウィザードを完了すると、プロジェクトに`config.yaml`ファイルが保存されます。このファイルは完全にコメント化されており、各オプションを説明し、利用可能なすべての選択肢をリストアップしているため、後で手動で確認・修正するのが簡単です。
|
|
92
|
+
|
|
93
|
+
以下は生成されたファイルのスニペットです。
|
|
94
|
+
|
|
95
|
+
```yaml config.yaml icon=logos:yaml
|
|
96
|
+
# ドキュメント公開のためのプロジェクト情報
|
|
97
|
+
projectName: your-project-name
|
|
98
|
+
projectDesc: Your project description.
|
|
99
|
+
projectLogo: ""
|
|
100
|
+
|
|
101
|
+
# =============================================================================
|
|
102
|
+
# ドキュメント設定
|
|
103
|
+
# =============================================================================
|
|
104
|
+
|
|
105
|
+
# 目的: 読者に達成してほしい主な成果は何ですか?
|
|
106
|
+
# 利用可能なオプション(必要に応じてコメントを解除して変更してください):
|
|
107
|
+
# getStarted - すぐに始める:新規ユーザーが30分以内にゼロから作業を開始できるように支援します
|
|
108
|
+
# completeTasks - 特定のタスクを完了する:一般的なワークフローやユースケースをユーザーに案内します
|
|
109
|
+
documentPurpose:
|
|
110
|
+
- completeTasks
|
|
111
|
+
- findAnswers
|
|
112
|
+
|
|
113
|
+
# 対象読者: これを最も頻繁に読むのは誰ですか?
|
|
114
|
+
# 利用可能なオプション(必要に応じてコメントを解除して変更してください):
|
|
115
|
+
# endUsers - エンドユーザー(非技術的):製品を使用するがコーディングはしない人々
|
|
116
|
+
# developers - 開発者(製品/APIを統合):これを自分のプロジェクトに追加するエンジニア
|
|
117
|
+
targetAudienceTypes:
|
|
118
|
+
- endUsers
|
|
119
|
+
- developers
|
|
120
|
+
|
|
121
|
+
# ... その他の設定
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## 次のステップ
|
|
125
|
+
|
|
126
|
+
設定ファイルが準備できたので、ドキュメントの生成、翻訳、または公開を行う準備が整いました。
|
|
127
|
+
|
|
128
|
+
<x-cards>
|
|
129
|
+
<x-card data-title="ドキュメントの生成" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
|
|
130
|
+
単一のコマンドを使用して、ソースコードから完全なドキュメントセットを自動的に作成する方法を学びます。
|
|
131
|
+
</x-card>
|
|
132
|
+
<x-card data-title="設定ガイド" data-icon="lucide:settings" data-href="/configuration">
|
|
133
|
+
利用可能なすべての設定を深く掘り下げ、`config.yaml`ファイルを手動で微調整する方法を学びます。
|
|
134
|
+
</x-card>
|
|
135
|
+
</x-cards>
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# 互動式設定
|
|
2
|
+
|
|
3
|
+
AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init` 指令啟動,以簡化專案設定。此引導式流程會詢問一系列關於您文件目標的問題,並根據您的回答產生一個 `config.yaml` 檔案。這是開始新文件專案的建議方法,因為它有助於防止設定錯誤,並根據您的輸入提供具體建議。
|
|
4
|
+
|
|
5
|
+
## 執行精靈
|
|
6
|
+
|
|
7
|
+
若要開始此流程,請在您專案的根目錄中執行以下指令:
|
|
8
|
+
|
|
9
|
+
```bash aigne doc init icon=lucide:sparkles
|
|
10
|
+
npx aigne doc init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
精靈接著會引導您完成一個 8 步驟的流程來設定您的文件。
|
|
14
|
+
|
|
15
|
+
## 引導式流程
|
|
16
|
+
|
|
17
|
+
精靈會提示您輸入以下關鍵設定詳細資訊:
|
|
18
|
+
|
|
19
|
+
1. **主要目標**:定義讀者的主要目的(例如,開始使用、尋找答案)。
|
|
20
|
+
2. **目標受眾**:指明文件的主要讀者(例如,非技術性終端使用者、開發人員)。
|
|
21
|
+
3. **讀者知識水平**:評估您受眾的典型起始知識水平。
|
|
22
|
+
4. **文件深度**:決定內容的詳細程度和範圍。
|
|
23
|
+
5. **主要語言**:設定文件的主要語言。
|
|
24
|
+
6. **翻譯語言**:選擇額外的翻譯語言。
|
|
25
|
+
7. **輸出目錄**:指定產生文件檔案的位置。
|
|
26
|
+
8. **原始碼路徑**:定義要分析的檔案和目錄,支援 glob 模式。
|
|
27
|
+
|
|
28
|
+
## 輔助設定
|
|
29
|
+
|
|
30
|
+
精靈使用一組預定義的規則來幫助您建立一個一致且有效的設定。
|
|
31
|
+
|
|
32
|
+
```d2
|
|
33
|
+
direction: down
|
|
34
|
+
|
|
35
|
+
User-Selections: {
|
|
36
|
+
label: "1. 使用者提供輸入\n(目的、受眾等)"
|
|
37
|
+
shape: rectangle
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
Wizard-Engine: {
|
|
41
|
+
label: "2. 精靈的規則引擎"
|
|
42
|
+
shape: rectangle
|
|
43
|
+
grid-columns: 2
|
|
44
|
+
|
|
45
|
+
Filtering: {
|
|
46
|
+
label: "選項篩選\n(防止不相容的選擇)"
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
Conflict-Detection: {
|
|
50
|
+
label: "衝突偵測\n(識別複雜需求)"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
Guided-Experience: {
|
|
55
|
+
label: "3. 引導式體驗"
|
|
56
|
+
shape: rectangle
|
|
57
|
+
content: "使用者看到簡化且相關的選項"
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
Final-Config: {
|
|
61
|
+
label: "4. 最終設定"
|
|
62
|
+
content: "config.yaml 產生時帶有\n衝突解決策略"
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
User-Selections -> Wizard-Engine
|
|
66
|
+
Wizard-Engine.Filtering -> Guided-Experience
|
|
67
|
+
Wizard-Engine.Conflict-Detection -> Final-Config
|
|
68
|
+
Guided-Experience -> User-Selections: "優化"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 預設建議與選項篩選
|
|
72
|
+
|
|
73
|
+
當您進行選擇時,精靈會提供預設值並篩選後續選項,以引導您進行邏輯性的設定。這是基於一組跨問題的衝突規則。
|
|
74
|
+
|
|
75
|
+
- **預設建議**:如果您選擇「快速入門」作為主要目標,精靈會建議將讀者的知識水平設定為「完全是初學者」。
|
|
76
|
+
- **即時篩選**:如果您的目標受眾是「終端使用者(非技術人員)」,精靈將會隱藏「是專家」的知識水平選項。此規則的理由是非技術使用者通常不是經驗豐富的技術使用者,從而防止不相容的選擇。
|
|
77
|
+
|
|
78
|
+
### 衝突偵測與解決
|
|
79
|
+
|
|
80
|
+
在某些情況下,您可能有多個目標或受眾,需要特定的文件結構才能有效,例如為非技術性的**終端使用者**和專家級的**開發人員**建立文件。精靈會將這些情況識別為「可解決的衝突」。
|
|
81
|
+
|
|
82
|
+
然後,它會制定一個策略,在文件結構中解決這些需求。對於終端使用者與開發人員的例子,解決策略是建立獨立的使用者路徑:
|
|
83
|
+
|
|
84
|
+
- **使用者指南路徑**:使用淺顯的語言,專注於 UI 互動,並以業務成果為導向。
|
|
85
|
+
- **開發人員指南路徑**:以程式碼為優先,技術上精確,並包含 SDK 範例和設定片段。
|
|
86
|
+
|
|
87
|
+
這種方法確保最終的文件結構能夠有效地服務多個受眾,而不是建立單一、混亂的內容組合。
|
|
88
|
+
|
|
89
|
+
## 產生的輸出
|
|
90
|
+
|
|
91
|
+
完成精靈後,它會在您的專案中儲存一個 `config.yaml` 檔案。此檔案有完整的註解,解釋了每個選項並列出了所有可用的選擇,使其易於稍後手動檢閱和修改。
|
|
92
|
+
|
|
93
|
+
以下是產生的檔案片段:
|
|
94
|
+
|
|
95
|
+
```yaml config.yaml icon=logos:yaml
|
|
96
|
+
# 用於文件發布的專案資訊
|
|
97
|
+
projectName: your-project-name
|
|
98
|
+
projectDesc: 您的專案描述。
|
|
99
|
+
projectLogo: ""
|
|
100
|
+
|
|
101
|
+
# =============================================================================
|
|
102
|
+
# 文件設定
|
|
103
|
+
# =============================================================================
|
|
104
|
+
|
|
105
|
+
# 目的:您希望讀者達成的最主要成果是什麼?
|
|
106
|
+
# 可用選項(取消註解並視需要修改):
|
|
107
|
+
# getStarted - 快速入門:幫助新使用者在 30 分鐘內從零到上手
|
|
108
|
+
# completeTasks - 完成特定任務:引導使用者完成常見的工作流程和使用案例
|
|
109
|
+
documentPurpose:
|
|
110
|
+
- completeTasks
|
|
111
|
+
- findAnswers
|
|
112
|
+
|
|
113
|
+
# 目標受眾:誰會最常閱讀此文件?
|
|
114
|
+
# 可用選項(取消註解並視需要修改):
|
|
115
|
+
# endUsers - 終端使用者(非技術人員):使用產品但不編寫程式碼的人
|
|
116
|
+
# developers - 開發人員整合您的產品/API:將此產品/API 加入其專案的工程師
|
|
117
|
+
targetAudienceTypes:
|
|
118
|
+
- endUsers
|
|
119
|
+
- developers
|
|
120
|
+
|
|
121
|
+
# ... 其他設定
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## 後續步驟
|
|
125
|
+
|
|
126
|
+
設定檔案就緒後,您就可以產生、翻譯或發布您的文件了。
|
|
127
|
+
|
|
128
|
+
<x-cards>
|
|
129
|
+
<x-card data-title="產生文件" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
|
|
130
|
+
了解如何使用單一指令從您的原始碼自動建立一套完整的文件。
|
|
131
|
+
</x-card>
|
|
132
|
+
<x-card data-title="設定指南" data-icon="lucide:settings" data-href="/configuration">
|
|
133
|
+
深入了解所有可用的設定,並學習如何手動微調 config.yaml 檔案。
|
|
134
|
+
</x-card>
|
|
135
|
+
</x-cards>
|
|
@@ -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,24 +10,24 @@ 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. **主要语言**:设置文档的主要语言。
|
|
24
|
-
6.
|
|
25
|
-
7.
|
|
24
|
+
6. **翻译语言**:选择用于翻译的其他语言。
|
|
25
|
+
7. **输出目录**:指定生成的文档文件的位置。
|
|
26
26
|
8. **源代码路径**:定义要分析的文件和目录,支持 glob 模式。
|
|
27
27
|
|
|
28
28
|
## 辅助配置
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
向导使用一套预定义的规则来帮助您创建连贯且有效的配置。
|
|
31
31
|
|
|
32
32
|
```d2
|
|
33
33
|
direction: down
|
|
@@ -43,7 +43,7 @@ Wizard-Engine: {
|
|
|
43
43
|
grid-columns: 2
|
|
44
44
|
|
|
45
45
|
Filtering: {
|
|
46
|
-
label: "
|
|
46
|
+
label: "选项过滤\n(防止不兼容的选择)"
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
Conflict-Detection: {
|
|
@@ -59,61 +59,61 @@ Guided-Experience: {
|
|
|
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
|
|
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
|
+
- **默认建议**:如果您选择“快速入门”作为主要目标,向导将推荐“完全是初学者”作为读者的知识水平。
|
|
76
|
+
- **实时过滤**:如果您的目标受众是“最终用户(非技术人员)”,向导将隐藏“是专家”这个知识水平选项。该规则的理由是,非技术用户通常不是经验丰富的技术用户,从而防止了不兼容的选择。
|
|
77
77
|
|
|
78
78
|
### 冲突检测与解决
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
在某些情况下,您可能有多个目标或受众,需要特定的文档结构才能有效,例如为非技术的**最终用户**和专业的**开发者**创建文档。向导将这些情况识别为“可解决的冲突”。
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
然后,它会制定一个策略来在文档结构中满足这些需求。对于最终用户与开发者的例子,解决策略是创建独立的用户路径:
|
|
83
83
|
|
|
84
|
-
- **用户指南路径**:使用通俗易懂的语言,侧重于 UI
|
|
84
|
+
- **用户指南路径**:使用通俗易懂的语言,侧重于 UI 交互,并面向业务成果。
|
|
85
85
|
- **开发者指南路径**:代码优先,技术上精确,并包含 SDK 示例和配置片段。
|
|
86
86
|
|
|
87
87
|
这种方法确保最终的文档结构能够有效地服务于多个受众,而不是创建一个单一、混乱的内容混合体。
|
|
88
88
|
|
|
89
|
-
##
|
|
89
|
+
## 生成的输出
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
完成向导后,它会在您的项目中保存一个 `config.yaml` 文件。该文件带有完整的注释,解释了每个选项并列出了所有可用选择,这使得以后手动审查和修改变得容易。
|
|
92
92
|
|
|
93
93
|
以下是生成文件的片段:
|
|
94
94
|
|
|
95
95
|
```yaml config.yaml icon=logos:yaml
|
|
96
96
|
# 用于文档发布的项目信息
|
|
97
97
|
projectName: your-project-name
|
|
98
|
-
projectDesc:
|
|
98
|
+
projectDesc: 您的项目描述。
|
|
99
99
|
projectLogo: ""
|
|
100
100
|
|
|
101
101
|
# =============================================================================
|
|
102
102
|
# 文档配置
|
|
103
103
|
# =============================================================================
|
|
104
104
|
|
|
105
|
-
#
|
|
105
|
+
# 目的:您希望读者达到的主要结果是什么?
|
|
106
106
|
# 可用选项(根据需要取消注释并修改):
|
|
107
|
-
# getStarted - 快速入门:帮助新用户在 30
|
|
108
|
-
# completeTasks -
|
|
107
|
+
# getStarted - 快速入门:帮助新用户在 <30 分钟内从零到上手
|
|
108
|
+
# completeTasks - 完成特定任务:引导用户完成常见工作流程和用例
|
|
109
109
|
documentPurpose:
|
|
110
110
|
- completeTasks
|
|
111
111
|
- findAnswers
|
|
112
112
|
|
|
113
|
-
#
|
|
113
|
+
# 目标受众:谁会最常阅读这份文档?
|
|
114
114
|
# 可用选项(根据需要取消注释并修改):
|
|
115
|
-
# endUsers -
|
|
116
|
-
# developers -
|
|
115
|
+
# endUsers - 最终用户(非技术人员):使用产品但不编码的人
|
|
116
|
+
# developers - 开发者(集成您的产品/API):将此添加到其项目中的工程师
|
|
117
117
|
targetAudienceTypes:
|
|
118
118
|
- endUsers
|
|
119
119
|
- developers
|
|
@@ -123,7 +123,7 @@ targetAudienceTypes:
|
|
|
123
123
|
|
|
124
124
|
## 后续步骤
|
|
125
125
|
|
|
126
|
-
|
|
126
|
+
配置文件就位后,您就可以生成、翻译或发布您的文档了。
|
|
127
127
|
|
|
128
128
|
<x-cards>
|
|
129
129
|
<x-card data-title="生成文档" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# 言語サポート
|
|
2
|
+
|
|
3
|
+
AIGNE DocSmithはAIを使用して、12言語への自動ドキュメント翻訳を提供します。これにより、`aigne doc translate`コマンドを使用して、世界中の読者向けのドキュメントを生成および維持できます。
|
|
4
|
+
|
|
5
|
+
翻訳ワークフローは、ソースドキュメントをAIエンジンで処理し、選択したターゲット言語でローカライズされたバージョンを生成します。
|
|
6
|
+
|
|
7
|
+
```d2
|
|
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
|
+
```
|
|
36
|
+
|
|
37
|
+
## サポートされている言語
|
|
38
|
+
|
|
39
|
+
DocSmithは、以下の言語に対してAIによる翻訳を提供します。プロジェクトの初期設定時に主要言語を定義し、翻訳対象として任意の数のターゲット言語を選択できます。
|
|
40
|
+
|
|
41
|
+
| 言語 | 言語コード | サンプルテキスト |
|
|
42
|
+
|---|---|---|
|
|
43
|
+
| English | `en` | こんにちは |
|
|
44
|
+
| 简体中文 | `zh` | 你好 |
|
|
45
|
+
| 繁體中文 | `zh-TW` | 你好 |
|
|
46
|
+
| 日本語 | `ja` | こんにちは |
|
|
47
|
+
| 한국어 | `ko` | 안녕하세요 |
|
|
48
|
+
| Español | `es` | Hola |
|
|
49
|
+
| Français | `fr` | Bonjour |
|
|
50
|
+
| Deutsch | `de` | Hallo |
|
|
51
|
+
| Português | `pt` | Olá |
|
|
52
|
+
| Русский | `ru` | Привет |
|
|
53
|
+
| Italiano | `it` | Ciao |
|
|
54
|
+
| العربية | `ar` | مرحبا |
|
|
55
|
+
|
|
56
|
+
## 翻訳の設定と使用方法
|
|
57
|
+
|
|
58
|
+
翻訳言語は、`aigne doc init`でプロジェクトを初期化する際に設定されます。`aigne doc translate`コマンドを使用すれば、いつでも新しい言語を追加したり、ドキュメントを翻訳したりできます。このコマンドには2つの操作モードがあります。
|
|
59
|
+
|
|
60
|
+
### ガイド付き翻訳のためのインタラクティブモード
|
|
61
|
+
|
|
62
|
+
ステップバイステップのガイド付きエクスペリエンスを利用するには、引数なしでコマンドを実行します。これはほとんどのユーザーに推奨されるアプローチです。
|
|
63
|
+
|
|
64
|
+
```bash Interactive Translation icon=lucide:wand
|
|
65
|
+
aigne doc translate
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
インタラクティブモードでは、一連のプロンプトが表示され、以下の操作が可能です:
|
|
69
|
+
|
|
70
|
+
1. 既存のドキュメントのリストから翻訳するものを選択する。
|
|
71
|
+
2. サポートされているリストから1つ以上のターゲット言語を選択する。
|
|
72
|
+
3. プロジェクトの設定にまだ含まれていない新しい翻訳言語を追加する。
|
|
73
|
+
|
|
74
|
+
### 自動化のためのコマンドライン引数
|
|
75
|
+
|
|
76
|
+
直接的な制御や自動化スクリプトで使用するために、ドキュメントと言語をコマンドライン引数として直接指定できます。これは開発者やCI/CDパイプラインに最適です。
|
|
77
|
+
|
|
78
|
+
```bash Command Example icon=lucide:terminal
|
|
79
|
+
# overview.mdとexamples.mdを中国語と日本語に翻訳
|
|
80
|
+
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
このコマンドの主要なパラメータは次のとおりです:
|
|
84
|
+
|
|
85
|
+
| パラメータ | 説明 |
|
|
86
|
+
|---|---|
|
|
87
|
+
| `--langs` | ターゲット言語の言語コードを指定します。このフラグは複数回使用して、いくつかの言語を選択できます。 |
|
|
88
|
+
| `--docs` | 翻訳するドキュメントへのパスを指定します(例:`overview.md`)。これも複数回使用できます。 |
|
|
89
|
+
| `--feedback` | 翻訳モデルをガイドするための具体的な指示を提供します(例:`"フォーマルなトーンを使用する"`)。 |
|
|
90
|
+
| `--glossary` | カスタム用語集ファイル(例:`@path/to/glossary.md`)を使用して、プロジェクト固有の用語の一貫した翻訳を保証します。 |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
このセクションでは、利用可能な言語とその有効化方法について説明しました。翻訳ワークフローに関する完全なガイドについては、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。
|