@aigne/doc-smith 0.8.12-beta.6 → 0.8.12-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/history.yaml +37 -0
- package/.aigne/doc-smith/preferences.yml +12 -0
- package/.aigne/doc-smith/upload-cache.yaml +30 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +12 -0
- package/agents/generate/update-document-structure.yaml +9 -3
- package/agents/history/view.mjs +5 -2
- package/agents/update/generate-document.yaml +10 -4
- package/agents/update/update-document-detail.yaml +9 -3
- package/agents/update/user-review-document.mjs +2 -1
- package/docs/guides-cleaning-up.ja.md +16 -15
- package/docs/guides-cleaning-up.md +5 -4
- package/docs/guides-cleaning-up.zh-TW.md +16 -15
- package/docs/guides-cleaning-up.zh.md +12 -11
- package/docs/guides-generating-documentation.ja.md +34 -32
- package/docs/guides-generating-documentation.md +15 -13
- package/docs/guides-generating-documentation.zh-TW.md +34 -32
- package/docs/guides-generating-documentation.zh.md +30 -28
- package/docs/guides-managing-history.ja.md +17 -20
- package/docs/guides-managing-history.md +5 -8
- package/docs/guides-managing-history.zh-TW.md +18 -21
- package/docs/guides-managing-history.zh.md +13 -16
- package/docs/guides-translating-documentation.ja.md +17 -17
- package/docs/guides-translating-documentation.md +1 -1
- package/docs/guides-translating-documentation.zh-TW.md +21 -21
- package/docs/guides-translating-documentation.zh.md +18 -18
- package/docs/guides-updating-documentation.ja.md +35 -35
- package/docs/guides-updating-documentation.md +4 -4
- package/docs/guides-updating-documentation.zh-TW.md +27 -27
- package/docs/guides-updating-documentation.zh.md +26 -26
- package/docs/overview.ja.md +13 -13
- package/docs/overview.md +1 -1
- package/docs/overview.zh-TW.md +19 -19
- package/docs/overview.zh.md +16 -16
- package/package.json +1 -1
- package/prompts/common/afs/afs-tools-usage.md +5 -0
- package/prompts/common/afs/use-afs-instruction.md +1 -0
- package/prompts/detail/generate/system-prompt.md +0 -13
- package/prompts/detail/generate/user-prompt.md +7 -0
- package/prompts/detail/update/system-prompt.md +1 -2
- package/prompts/detail/update/user-prompt.md +7 -0
- package/prompts/structure/generate/system-prompt.md +0 -19
- package/prompts/structure/generate/user-prompt.md +22 -1
- package/prompts/structure/update/system-prompt.md +0 -17
- package/prompts/structure/update/user-prompt.md +24 -0
- package/tests/agents/history/view.test.mjs +97 -0
- package/tests/utils/history-utils.test.mjs +125 -97
- package/utils/file-utils.mjs +1 -1
- package/utils/history-utils.mjs +3 -3
- package/agents/update/fs-tools/glob.mjs +0 -184
- package/agents/update/fs-tools/grep.mjs +0 -317
- package/agents/update/fs-tools/read-file.mjs +0 -309
- package/tests/agents/update/fs-tools/glob.test.mjs +0 -438
- package/tests/agents/update/fs-tools/grep.test.mjs +0 -279
- package/tests/agents/update/fs-tools/read-file.test.mjs +0 -549
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# 產生文件
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本指南提供了一套系統化程序,可從您的專案原始檔案建立一套完整的文件。此程序透過 `aigne doc generate` 指令啟動,該指令會分析您的程式碼庫、提出邏輯結構,然後為每份文件撰寫內容。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
此指令是初次建立文件的主要工具。若要在文件建立後進行修改,請參閱 [更新文件](./guides-updating-documentation.md) 指南。
|
|
6
6
|
|
|
7
7
|
### 產生工作流程
|
|
8
8
|
|
|
9
|
-
`generate`
|
|
9
|
+
`generate` 指令會執行一系列自動化步驟來建置您的文件。此程序設計為互動式,讓您能在內容撰寫前審閱並批准建議的結構。
|
|
10
10
|
|
|
11
11
|
```d2
|
|
12
12
|
direction: down
|
|
@@ -38,12 +38,12 @@ propose_structure: {
|
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
review_structure: {
|
|
41
|
-
label: "
|
|
41
|
+
label: "使用者審閱建議的結構"
|
|
42
42
|
shape: rectangle
|
|
43
43
|
}
|
|
44
44
|
|
|
45
45
|
user_approve: {
|
|
46
|
-
label: "
|
|
46
|
+
label: "批准結構?"
|
|
47
47
|
shape: diamond
|
|
48
48
|
}
|
|
49
49
|
|
|
@@ -54,7 +54,7 @@ provide_feedback: {
|
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
generate_content: {
|
|
57
|
-
label: "
|
|
57
|
+
label: "為所有文件生成內容"
|
|
58
58
|
shape: rectangle
|
|
59
59
|
}
|
|
60
60
|
|
|
@@ -86,53 +86,55 @@ generate_content -> end
|
|
|
86
86
|
|
|
87
87
|
## 逐步流程
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
若要產生您的文件,請在終端機中導覽至您專案的根目錄,並依照下列步驟操作。
|
|
90
90
|
|
|
91
|
-
### 1. 執行 Generate
|
|
91
|
+
### 1. 執行 Generate 指令
|
|
92
92
|
|
|
93
|
-
執行 `generate`
|
|
93
|
+
執行 `generate` 指令以開始此程序。工具將首先分析您專案的檔案與結構。
|
|
94
94
|
|
|
95
|
-
```bash
|
|
95
|
+
```bash 基本產生指令
|
|
96
96
|
aigne doc generate
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
為求簡潔,您也可以使用別名 `gen` 或 `g`。
|
|
100
100
|
|
|
101
|
-
### 2.
|
|
101
|
+
### 2. 審閱文件結構
|
|
102
102
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
系統會提示您審查此計畫:
|
|
103
|
+
分析完成後,工具將顯示建議的文件結構,並提示您進行審閱:
|
|
106
104
|
|
|
107
105
|
```
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
是,最佳化結構
|
|
106
|
+
Would you like to optimize the documentation structure?
|
|
107
|
+
❯ No, looks good
|
|
108
|
+
Yes, optimize the structure (e.g. rename 'Getting Started' to 'Quick Start', move 'API Reference' before 'Configuration')
|
|
112
109
|
```
|
|
113
110
|
|
|
114
|
-
-
|
|
115
|
-
-
|
|
111
|
+
- **不,看起來不錯**:選擇此選項可批准建議的結構,並直接進入內容產生階段。
|
|
112
|
+
- **是的,最佳化結構**:選擇此選項可修改計畫。工具接著會以互動式循環徵詢您的回饋。您可以用純文字提供指令,例如:
|
|
113
|
+
- `新增一份名為「疑難排解」的文件`
|
|
114
|
+
- `移除「舊版功能」文件`
|
|
115
|
+
- `將「安裝」移至結構頂部`
|
|
116
|
+
|
|
117
|
+
在每次回饋後,AI 將會修訂結構,您可以再次審閱。若要結束循環並批准最終結構,直接按下 Enter 鍵,不輸入任何回饋即可。
|
|
116
118
|
|
|
117
119
|
### 3. 內容產生
|
|
118
120
|
|
|
119
|
-
|
|
121
|
+
文件結構一經批准,DocSmith 將開始為計畫中的每份文件產生詳細內容。此過程會自動執行,其持續時間取決於您專案的規模與複雜度。
|
|
120
122
|
|
|
121
123
|
完成後,產生的檔案將儲存至您設定中指定的輸出目錄(例如 `./docs`)。
|
|
122
124
|
|
|
123
|
-
##
|
|
125
|
+
## 指令參數
|
|
124
126
|
|
|
125
|
-
`generate`
|
|
127
|
+
`generate` 指令接受數個選用參數以控制其行為。
|
|
126
128
|
|
|
127
129
|
| 參數 | 說明 | 範例 |
|
|
128
|
-
|
|
129
|
-
| `--forceRegenerate` |
|
|
130
|
-
| `--feedback` |
|
|
131
|
-
| `--glossary` |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| `--forceRegenerate` | 從頭開始重建所有文件,忽略任何現有的結構或內容。當您想要完全重置時,此選項非常有用。 | `aigne doc generate --forceRegenerate` |
|
|
132
|
+
| `--feedback` | 在互動式審閱開始前,提供初始的文字指令,以在結構產生階段指導 AI。 | `aigne doc generate --feedback "新增更多 API 範例"` |
|
|
133
|
+
| `--glossary` | 指定一個詞彙表檔案(例如 glossary.md),以確保在整個文件中術語使用的一致性。 | `aigne doc generate --glossary @/path/to/glossary.md` |
|
|
132
134
|
|
|
133
|
-
###
|
|
135
|
+
### 範例:強制完整重建
|
|
134
136
|
|
|
135
|
-
|
|
137
|
+
如果您想捨棄所有先前產生的文件,並根據您程式碼的當前狀態建立一套新的文件,請使用 `--forceRegenerate` 旗標。
|
|
136
138
|
|
|
137
139
|
```bash 強制重新產生
|
|
138
140
|
aigne doc generate --forceRegenerate
|
|
@@ -140,10 +142,10 @@ aigne doc generate --forceRegenerate
|
|
|
140
142
|
|
|
141
143
|
## 總結
|
|
142
144
|
|
|
143
|
-
`generate`
|
|
145
|
+
`generate` 指令統籌了建立您初始專案文件的整個過程。它結合了自動化程式碼分析與互動式審閱流程,以產出一套結構化且相關的文件。
|
|
144
146
|
|
|
145
147
|
文件產生後,您可能會想:
|
|
146
148
|
|
|
147
149
|
- [更新文件](./guides-updating-documentation.md):對特定文件進行變更。
|
|
148
150
|
- [翻譯文件](./guides-translating-documentation.md):將您的內容翻譯成其他語言。
|
|
149
|
-
- [
|
|
151
|
+
- [發布您的文件](./guides-publishing-your-docs.md):將您的文件發布上線。
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# 生成文档
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本指南提供了从项目源文件创建一套完整文档的系统化流程。该流程通过 `aigne doc generate` 命令启动,该命令会分析你的代码库,提出一个逻辑结构,然后为每个文档编写内容。
|
|
4
4
|
|
|
5
5
|
该命令是初次创建文档的主要工具。如需在文档创建后进行修改,请参阅[更新文档](./guides-updating-documentation.md)指南。
|
|
6
6
|
|
|
7
7
|
### 生成工作流
|
|
8
8
|
|
|
9
|
-
`generate`
|
|
9
|
+
`generate` 命令会执行一系列自动化步骤来构建你的文档。该流程设计为交互式,允许你在内容写入前审查并批准建议的结构。
|
|
10
10
|
|
|
11
11
|
```d2
|
|
12
12
|
direction: down
|
|
@@ -29,7 +29,7 @@ check_config: {
|
|
|
29
29
|
interactive_setup: {
|
|
30
30
|
label: "引导进行交互式设置"
|
|
31
31
|
shape: rectangle
|
|
32
|
-
tooltip: "如果未找到 .aigne/doc-smith/config.yaml
|
|
32
|
+
tooltip: "如果未找到 .aigne/doc-smith/config.yaml,则会触发交互式设置。"
|
|
33
33
|
}
|
|
34
34
|
|
|
35
35
|
propose_structure: {
|
|
@@ -50,7 +50,7 @@ user_approve: {
|
|
|
50
50
|
provide_feedback: {
|
|
51
51
|
label: "提供反馈以优化结构"
|
|
52
52
|
shape: rectangle
|
|
53
|
-
tooltip: "
|
|
53
|
+
tooltip: "用户可以请求更改,例如重命名、添加或删除章节。"
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
generate_content: {
|
|
@@ -86,53 +86,55 @@ generate_content -> end
|
|
|
86
86
|
|
|
87
87
|
## 分步流程
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
要生成文档,请在终端中导航到项目的根目录,并按照以下步骤操作。
|
|
90
90
|
|
|
91
91
|
### 1. 运行生成命令
|
|
92
92
|
|
|
93
|
-
执行 `generate`
|
|
93
|
+
执行 `generate` 命令以开始此过程。该工具将首先分析你项目的文件和结构。
|
|
94
94
|
|
|
95
|
-
```bash
|
|
95
|
+
```bash 基本生成命令
|
|
96
96
|
aigne doc generate
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
为简洁起见,你也可以使用别名 `gen` 或 `g`。
|
|
100
100
|
|
|
101
101
|
### 2. 审查文档结构
|
|
102
102
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
系统将提示您审查此计划:
|
|
103
|
+
分析完成后,该工具将显示建议的文档结构并提示你进行审查:
|
|
106
104
|
|
|
107
105
|
```
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
是的,优化结构
|
|
106
|
+
你希望优化文档结构吗?
|
|
107
|
+
❯ 不,看起来不错
|
|
108
|
+
是的,优化结构(例如,将“入门指南”重命名为“快速入门”,将“API 参考”移至“配置”之前)
|
|
112
109
|
```
|
|
113
110
|
|
|
114
|
-
-
|
|
115
|
-
-
|
|
111
|
+
- **不,看起来不错**:选择此选项以批准建议的结构,并直接进入内容生成阶段。
|
|
112
|
+
- **是的,优化结构**:选择此选项以修改计划。该工具将在一个交互式循环中征求你的反馈。你可以用纯文本提供指令,例如:
|
|
113
|
+
- `添加一个新文档“故障排除”`
|
|
114
|
+
- `删除“旧版功能”文档`
|
|
115
|
+
- `将“安装”移动到结构顶部`
|
|
116
|
+
|
|
117
|
+
在每次反馈后,AI 将修订结构,你可以再次审查。不输入任何反馈直接按 Enter 键即可退出循环并批准最终结构。
|
|
116
118
|
|
|
117
119
|
### 3. 内容生成
|
|
118
120
|
|
|
119
|
-
|
|
121
|
+
文档结构一经批准,DocSmith 将开始为计划中的每个文档生成详细内容。此过程自动运行,其持续时间取决于项目的规模和复杂性。
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
完成后,生成的文件将保存到你在配置中指定的输出目录(例如 `./docs`)。
|
|
122
124
|
|
|
123
125
|
## 命令参数
|
|
124
126
|
|
|
125
|
-
`generate`
|
|
127
|
+
`generate` 命令接受几个可选参数以控制其行为。
|
|
126
128
|
|
|
127
129
|
| 参数 | 描述 | 示例 |
|
|
128
|
-
|
|
129
|
-
| `--forceRegenerate` |
|
|
130
|
-
| `--feedback` |
|
|
131
|
-
| `--glossary` |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| `--forceRegenerate` | 从头开始重建所有文档,忽略任何现有结构或内容。当你想要完全重置时,此选项非常有用。 | `aigne doc generate --forceRegenerate` |
|
|
132
|
+
| `--feedback` | 在交互式审查开始前,提供基于文本的初始指令,以在结构生成阶段指导 AI。 | `aigne doc generate --feedback "添加更多 API 示例"` |
|
|
133
|
+
| `--glossary` | 指定一个术语表文件(例如 `glossary.md`),以确保在整个文档中术语使用的一致性。 | `aigne doc generate --glossary @/path/to/glossary.md` |
|
|
132
134
|
|
|
133
135
|
### 示例:强制完全重建
|
|
134
136
|
|
|
135
|
-
|
|
137
|
+
如果你想丢弃所有先前生成的文档,并根据代码的当前状态创建一套新文档,请使用 `--forceRegenerate` 标志。
|
|
136
138
|
|
|
137
139
|
```bash 强制重新生成
|
|
138
140
|
aigne doc generate --forceRegenerate
|
|
@@ -142,8 +144,8 @@ aigne doc generate --forceRegenerate
|
|
|
142
144
|
|
|
143
145
|
`generate` 命令协调了创建初始项目文档的整个过程。它将自动代码分析与交互式审查过程相结合,以生成一套结构化且相关的文档。
|
|
144
146
|
|
|
145
|
-
|
|
147
|
+
文档生成后,你可能希望:
|
|
146
148
|
|
|
147
149
|
- [更新文档](./guides-updating-documentation.md):对特定文档进行更改。
|
|
148
|
-
- [翻译文档](./guides-translating-documentation.md)
|
|
149
|
-
- [
|
|
150
|
+
- [翻译文档](./guides-translating-documentation.md):将你的内容翻译成其他语言。
|
|
151
|
+
- [发布你的文档](./guides-publishing-your-docs.md):将你的文档在线发布。
|
|
@@ -1,51 +1,48 @@
|
|
|
1
1
|
# 履歴の管理
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmithは、ドキュメントに加えられたすべての更新の時系列ログを保持します。この機能により、変更を追跡し、更新時に提供されたフィードバックを確認し、時間とともにドキュメントがどのように変化したかを理解できます。このガイドでは、この履歴にアクセスして解釈する方法について説明します。
|
|
4
4
|
|
|
5
5
|
## 更新履歴の表示
|
|
6
6
|
|
|
7
|
-
すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1
|
|
7
|
+
すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1行の要約を表示します。
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
ターミナルで次のコマンドを実行してください:
|
|
10
10
|
|
|
11
11
|
```bash 履歴の表示 icon=material-symbols:history
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list`
|
|
15
|
+
`history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list` もサポートしています。以下のコマンドは同等であり、同じ出力を生成します:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
22
|
### 履歴出力の理解
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` コマンドの出力は、各更新に関する主要な情報を一目でわかるようにフォーマットされています。各行は、1つの更新エントリを表します。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下にそのフォーマットの内訳を示します:
|
|
30
27
|
|
|
31
28
|
| コンポーネント | 説明 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
30
|
+
| **Short Hash** | 更新のタイムスタンプから生成される8文字の一意の識別子。 |
|
|
31
|
+
| **Date** | 更新が発生した時期を示す相対的なタイムスタンプ(例:「5 minutes ago」、「2 days ago」)。古いエントリには、特定の日付が表示されます。 |
|
|
32
|
+
| **Operation** | `generate_document` や `update_document_detail` など、実行されたアクションの種類。 |
|
|
33
|
+
| **Document Path** | 操作が単一ファイルを対象とした場合に、変更された特定のドキュメントのパス。これは括弧で囲まれます。 |
|
|
34
|
+
| **Feedback** | 更新が行われたときに提供されたフィードバックまたは要約メッセージ。 |
|
|
38
35
|
|
|
39
36
|
### 例
|
|
40
37
|
|
|
41
|
-
|
|
38
|
+
以下は `aigne history view` コマンドを実行した際のサンプル出力です。
|
|
42
39
|
|
|
43
40
|
```bash
|
|
44
|
-
📜
|
|
41
|
+
📜 Update History
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
44
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
45
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
|
|
48
|
+
このログは、ドキュメントの変更履歴を明確かつ整理された記録として提供し、進捗の追跡や過去の変更の確認に役立ちます。
|
|
@@ -16,9 +16,6 @@ The `history` command also supports two aliases for the `view` subcommand: `log`
|
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
@@ -30,9 +27,9 @@ Here is a breakdown of the format:
|
|
|
30
27
|
|
|
31
28
|
| Component | Description |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
| **Short Hash** |
|
|
30
|
+
| **Short Hash** | An 8-character unique identifier generated from the timestamp of the update. |
|
|
34
31
|
| **Date** | A relative timestamp indicating when the update occurred (e.g., "5 minutes ago", "2 days ago"). For older entries, a specific date is shown. |
|
|
35
|
-
| **Operation** | The type of action performed, such as `
|
|
32
|
+
| **Operation** | The type of action performed, such as `generate_document` or `update_document_detail`. |
|
|
36
33
|
| **Document Path** | The path of the specific document that was modified, if the operation targeted a single file. This is enclosed in parentheses. |
|
|
37
34
|
| **Feedback** | The feedback or summary message that was provided when the update was made. |
|
|
38
35
|
|
|
@@ -43,9 +40,9 @@ Below is a sample output from running the `aigne history view` command.
|
|
|
43
40
|
```bash
|
|
44
41
|
📜 Update History
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
44
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
45
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
46
|
```
|
|
50
47
|
|
|
51
48
|
This log provides a clear and orderly record of your documentation's modification history, which is useful for tracking progress and reviewing past changes.
|
|
@@ -1,39 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 管理歷史紀錄
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 會按時間順序記錄您對文件所做的所有更新。此功能可讓您追蹤變更、檢閱更新期間提供的回饋,並了解文件隨時間的演變過程。本指南將說明如何存取和解讀此歷史紀錄。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 查看更新歷史紀錄
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
若要查看所有文件的更新日誌,您可以使用 `history view` 指令。此指令會為每個項目顯示精簡的單行摘要,類似於版本控制的日誌。
|
|
8
8
|
|
|
9
9
|
在您的終端機中執行以下指令:
|
|
10
10
|
|
|
11
|
-
```bash
|
|
11
|
+
```bash 查看歷史紀錄 icon=material-symbols:history
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list
|
|
15
|
+
`history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list`。以下指令是等效的,將會產生相同的輸出:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
|
-
###
|
|
22
|
+
### 了解歷史紀錄輸出
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` 指令的輸出格式旨在讓您能一目了然地獲取每次更新的關鍵資訊。每一行代表一個單獨的更新項目。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下是其格式的詳細說明:
|
|
30
27
|
|
|
31
28
|
| 元件 | 說明 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
| **日期** |
|
|
35
|
-
| **操作** | 執行的操作類型,例如 `
|
|
36
|
-
| **文件路徑** |
|
|
30
|
+
| **簡短雜湊值** | 一個從更新時間戳產生的 8 字元唯一識別碼。 |
|
|
31
|
+
| **日期** | 一個相對時間戳,表示更新發生的時間(例如,「5 分鐘前」、「2 天前」)。對於較舊的項目,則會顯示具體日期。 |
|
|
32
|
+
| **操作** | 執行的操作類型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
+
| **文件路徑** | 如果操作針對的是單一檔案,則為被修改的特定文件的路徑。此路徑會用括號括起來。 |
|
|
37
34
|
| **回饋** | 進行更新時所提供的回饋或摘要訊息。 |
|
|
38
35
|
|
|
39
36
|
### 範例
|
|
@@ -41,11 +38,11 @@ aigne history list
|
|
|
41
38
|
以下是執行 `aigne history view` 指令的範例輸出。
|
|
42
39
|
|
|
43
40
|
```bash
|
|
44
|
-
📜
|
|
41
|
+
📜 更新歷史紀錄
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 小時前 update_document_detail (/guides/generating-documentation): 新增了關於進階設定選項的新章節。
|
|
44
|
+
a3b1c9d2 1 天前 update_document_detail (/overview): 修訂了簡介,使其更加簡潔。
|
|
45
|
+
f8d2e0c3 3 天前 generate_document (/guides/managing-history): 初次產生歷史紀錄管理指南。
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
|
|
48
|
+
此日誌提供了您文件修改歷史的清晰有序記錄,有助於追蹤進度和檢閱過去的變更。
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# 管理历史记录
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 会为您的文档所做的所有更新保留一份按时间顺序排列的日志。此功能允许您跟踪变更、审查更新期间提供的反馈,并了解文档随时间的演变过程。本指南说明了如何访问和解读此历史记录。
|
|
4
4
|
|
|
5
5
|
## 查看更新历史记录
|
|
6
6
|
|
|
7
|
-
要查看所有文档更新的日志,您可以使用 `history view`
|
|
7
|
+
要查看所有文档更新的日志,您可以使用 `history view` 命令。该命令会为每条记录显示一个紧凑的单行摘要,类似于版本控制日志。
|
|
8
8
|
|
|
9
9
|
在您的终端中执行以下命令:
|
|
10
10
|
|
|
@@ -12,29 +12,26 @@ AIGNE DocSmith 会按时间顺序记录对您文档所做的所有更新。此
|
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list
|
|
15
|
+
`history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list`。以下命令是等效的,并将产生相同的输出:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
22
|
### 理解历史记录输出
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` 命令的输出经过格式化,以便一目了然地提供每次更新的关键信息。每一行代表一条更新记录。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下是其格式的分解说明:
|
|
30
27
|
|
|
31
28
|
| 组件 | 描述 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
| **日期** |
|
|
35
|
-
| **操作** | 执行的操作类型,例如 `
|
|
36
|
-
| **文档路径** |
|
|
37
|
-
| **反馈** |
|
|
30
|
+
| **短哈希值** | 根据更新时间戳生成的 8 位字符唯一标识符。 |
|
|
31
|
+
| **日期** | 一个相对时间戳,表示更新发生的时间(例如,“5 分钟前”、“2 天前”)。对于较早的记录,会显示具体日期。 |
|
|
32
|
+
| **操作** | 执行的操作类型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
+
| **文档路径** | 如果操作针对单个文件,则为被修改的具体文档的路径。该路径包含在括号中。 |
|
|
34
|
+
| **反馈** | 更新时提供的反馈或摘要信息。 |
|
|
38
35
|
|
|
39
36
|
### 示例
|
|
40
37
|
|
|
@@ -43,9 +40,9 @@ aigne history list
|
|
|
43
40
|
```bash
|
|
44
41
|
📜 更新历史记录
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
44
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
45
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
46
|
```
|
|
50
47
|
|
|
51
48
|
此日志为您的文档修改历史提供了清晰有序的记录,有助于跟踪进度和回顾过去的变更。
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# ドキュメントの翻訳
|
|
2
2
|
|
|
3
|
-
このガイドでは、`aigne doc translate`
|
|
3
|
+
このガイドでは、`aigne doc translate` コマンドを使用して、生成されたドキュメントを多言語に翻訳する方法について説明します。このプロセスでは AI を使用して、翻訳が文脈を認識し、技術的な正確性を維持するようにします。
|
|
4
4
|
|
|
5
5
|
このツールは12の言語をサポートしており、世界中のオーディエンスにリーチすることができます。ソースドキュメントの主要言語は、利用可能な翻訳言語のリストから自動的に除外されます。
|
|
6
6
|
|
|
7
7
|
## `translate` コマンド
|
|
8
8
|
|
|
9
|
-
`aigne doc translate`
|
|
9
|
+
`aigne doc translate` コマンドは、既存のドキュメントファイルの翻訳を生成するために使用されます。対話形式で実行して、翻訳したいドキュメントと言語を選択することも、自動化されたワークフローのためにコマンドラインフラグを使用してこれらのオプションを直接指定することもできます。
|
|
10
10
|
|
|
11
|
-
###
|
|
11
|
+
### 対話モード
|
|
12
12
|
|
|
13
13
|
ガイド付きのエクスペリエンスを利用するには、引数なしでコマンドを実行します。
|
|
14
14
|
|
|
@@ -18,21 +18,21 @@ aigne doc translate
|
|
|
18
18
|
|
|
19
19
|
実行されると、ツールは以下の手順を実行します。
|
|
20
20
|
1. 既存のドキュメントをスキャンします。
|
|
21
|
-
2.
|
|
22
|
-
3.
|
|
23
|
-
4.
|
|
24
|
-
5.
|
|
21
|
+
2. リストから翻訳したい特定のドキュメントを選択するように求めます。
|
|
22
|
+
3. 翻訳の対象言語を選択するように求めます。以前に選択した言語は、便宜上、事前にチェックされています。
|
|
23
|
+
4. 選択された各ドキュメントと言語のペアに対して翻訳プロセスを開始します。
|
|
24
|
+
5. 翻訳されたファイルを同じディレクトリに保存します。新しいファイルは、元のファイル名に言語コードを追加して命名されます(例:`overview.md` の中国語翻訳は `overview.zh.md` になります)。
|
|
25
25
|
|
|
26
26
|
### コマンドラインオプション
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
非対話的な使用やスクリプト作成のために、以下のコマンドラインフラグを使用して翻訳プロセスを制御できます。
|
|
29
29
|
|
|
30
30
|
<x-field-group>
|
|
31
31
|
<x-field data-name="--docs" data-type="array<string>">
|
|
32
|
-
<x-field-desc markdown
|
|
32
|
+
<x-field-desc markdown>翻訳する1つ以上のドキュメントパスを指定します。指定しない場合、ツールは対話モードに入り、利用可能なドキュメントのリストから選択できるようになります。</x-field-desc>
|
|
33
33
|
</x-field>
|
|
34
34
|
<x-field data-name="--langs" data-type="array<string>">
|
|
35
|
-
<x-field-desc markdown
|
|
35
|
+
<x-field-desc markdown>1つ以上のターゲット言語コード(例:`zh`、`ja`)を指定します。省略した場合、対話形式で言語を選択するように求められます。</x-field-desc>
|
|
36
36
|
</x-field>
|
|
37
37
|
<x-field data-name="--glossary" data-type="string">
|
|
38
38
|
<x-field-desc markdown>用語集ファイルへのパス(例:`@path/to/glossary.md`)を提供します。これにより、特定の技術用語がすべてのドキュメントで一貫して翻訳されるようになります。</x-field-desc>
|
|
@@ -46,13 +46,13 @@ aigne doc translate
|
|
|
46
46
|
|
|
47
47
|
#### 1. 特定のドキュメントを複数の言語に翻訳する
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
対話プロンプトなしで `overview.md` と `examples.md` を中国語(`zh`)と日本語(`ja`)に翻訳するには:
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
52
|
aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
#### 2.
|
|
55
|
+
#### 2. 用語集を使用して一貫した用語を確保する
|
|
56
56
|
|
|
57
57
|
技術用語が正しく翻訳されるように、用語集ファイルを提供します。これは、ブランド名や専門用語の一貫性を維持するのに役立ちます。
|
|
58
58
|
|
|
@@ -60,9 +60,9 @@ aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
|
|
|
60
60
|
aigne doc translate --glossary @./glossary.md
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
#### 3.
|
|
63
|
+
#### 3. フィードバックを提供して翻訳スタイルを洗練させる
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
フィードバックを提供することで、翻訳スタイルをガイドできます。例えば、よりフォーマルなトーンをリクエストするには:
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
68
|
aigne doc translate --feedback "Use a formal, technical tone for all translations."
|
|
@@ -88,8 +88,8 @@ aigne doc translate --feedback "Use a formal, technical tone for all translation
|
|
|
88
88
|
| イタリア語 | `it` |
|
|
89
89
|
| アラビア語 | `ar` |
|
|
90
90
|
|
|
91
|
-
##
|
|
91
|
+
## 概要
|
|
92
92
|
|
|
93
|
-
`translate`
|
|
93
|
+
`translate` コマンドは、ドキュメントをローカライズするための構造化された方法を提供します。対話モードを使用してガイド付きの翻訳を行ったり、コマンドラインオプションを使用して自動化されたワークフローを構築したりできます。用語集やフィードバックなどの機能を使用することで、翻訳コンテンツの品質と一貫性を維持するのに役立ちます。
|
|
94
94
|
|
|
95
|
-
ドキュメントを翻訳した後、[ドキュメントの公開](./guides-publishing-your-docs.md)
|
|
95
|
+
ドキュメントを翻訳した後、[ドキュメントの公開](./guides-publishing-your-docs.md)に進むことができます。
|
|
@@ -21,7 +21,7 @@ When executed, the tool will perform the following steps:
|
|
|
21
21
|
2. Prompt you to select the specific documents you wish to translate from a list.
|
|
22
22
|
3. Prompt you to select the target languages for translation. Previously selected languages will be pre-checked for convenience.
|
|
23
23
|
4. Begin the translation process for each selected document and language pair.
|
|
24
|
-
5. Save the translated files in the
|
|
24
|
+
5. Save the translated files in the same directory. The new files are named by appending a language code to the original filename (e.g., a Chinese translation of `overview.md` becomes `overview.zh.md`).
|
|
25
25
|
|
|
26
26
|
### Command-Line Options
|
|
27
27
|
|