@aigne/doc-smith 0.8.3 → 0.8.5
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 +3 -3
- package/.aigne/doc-smith/preferences.yml +58 -12
- package/.aigne/doc-smith/upload-cache.yaml +600 -207
- package/CHANGELOG.md +22 -0
- package/README.md +77 -5
- package/agents/input-generator.mjs +12 -6
- package/agents/publish-docs.mjs +53 -4
- package/docs/_sidebar.md +1 -1
- package/docs/advanced-how-it-works.md +55 -60
- package/docs/advanced-how-it-works.zh.md +60 -65
- package/docs/advanced-quality-assurance.md +73 -38
- package/docs/advanced-quality-assurance.zh.md +73 -38
- package/docs/advanced.md +2 -14
- package/docs/advanced.zh.md +5 -17
- package/docs/changelog.md +41 -4
- package/docs/changelog.zh.md +77 -40
- package/docs/cli-reference.md +79 -13
- package/docs/cli-reference.zh.md +92 -26
- package/docs/configuration-interactive-setup.md +102 -49
- package/docs/configuration-interactive-setup.zh.md +102 -49
- package/docs/configuration-language-support.md +69 -39
- package/docs/configuration-language-support.zh.md +68 -38
- package/docs/configuration-llm-setup.md +25 -62
- package/docs/configuration-llm-setup.zh.md +25 -62
- package/docs/configuration-preferences.md +79 -67
- package/docs/configuration-preferences.zh.md +78 -67
- package/docs/configuration.md +122 -109
- package/docs/configuration.zh.md +130 -117
- package/docs/features-generate-documentation.md +44 -24
- package/docs/features-generate-documentation.zh.md +52 -32
- package/docs/features-publish-your-docs.md +41 -40
- package/docs/features-publish-your-docs.zh.md +50 -49
- package/docs/features-translate-documentation.md +73 -17
- package/docs/features-translate-documentation.zh.md +76 -20
- package/docs/features-update-and-refine.md +72 -21
- package/docs/features-update-and-refine.zh.md +80 -29
- package/docs/features.md +24 -28
- package/docs/features.zh.md +25 -29
- package/docs/getting-started.md +87 -38
- package/docs/getting-started.zh.md +88 -39
- package/docs/overview.md +17 -35
- package/docs/overview.zh.md +18 -36
- package/package.json +9 -8
- package/prompts/content-detail-generator.md +1 -0
- package/prompts/document/custom-code-block.md +101 -0
- package/prompts/document/d2-chart/rules.md +941 -1031
- package/prompts/document/detail-generator.md +7 -53
- package/tests/input-generator.test.mjs +2 -2
- package/tests/kroki-utils.test.mjs +88 -17
- package/utils/auth-utils.mjs +9 -2
- package/utils/blocklet.mjs +25 -6
- package/utils/constants.mjs +17 -1
- package/utils/deploy.mjs +404 -0
- package/utils/kroki-utils.mjs +22 -14
- package/utils/markdown-checker.mjs +1 -1
- package/utils/utils.mjs +3 -2
- package/prompts/document/d2-chart/diy-examples.md +0 -44
- package/prompts/document/d2-chart/shape-rules.md +0 -182
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
# D2 图表绘制 Shape 选择指南与 Prompt 模板
|
|
2
|
-
|
|
3
|
-
## 一、D2 Shape 类型与使用场景
|
|
4
|
-
|
|
5
|
-
### 基础 Shape 类型
|
|
6
|
-
- **rectangle** (默认): 通用节点、组件、系统模块
|
|
7
|
-
- **square**: 数据库、存储、配置项
|
|
8
|
-
- **circle**: 用户、角色、状态节点
|
|
9
|
-
- **oval**: 开始/结束节点、事件
|
|
10
|
-
- **diamond**: 决策节点、条件判断
|
|
11
|
-
- **parallelogram**: 输入/输出、数据流
|
|
12
|
-
- **hexagon**: 准备、预处理步骤
|
|
13
|
-
- **cylinder**: 数据库、数据存储
|
|
14
|
-
- **queue**: 消息队列、缓冲区
|
|
15
|
-
- **package**: 模块、包、容器
|
|
16
|
-
- **step**: 流程步骤
|
|
17
|
-
- **callout**: 注释、说明
|
|
18
|
-
- **stored_data**: 存储的数据
|
|
19
|
-
- **person**: 用户、角色
|
|
20
|
-
- **diamond**: 判断、网关
|
|
21
|
-
- **document**: 文档、报告
|
|
22
|
-
- **multiple_document**: 多个文档
|
|
23
|
-
- **class**: 类定义
|
|
24
|
-
- **sql_table**: 数据库表
|
|
25
|
-
- **image**: 图片、媒体
|
|
26
|
-
|
|
27
|
-
## 二、针对不同图表类型的 Prompt 模板
|
|
28
|
-
|
|
29
|
-
### 1. 系统架构图 Prompt
|
|
30
|
-
```
|
|
31
|
-
请使用 D2 语法绘制系统架构图,遵循以下 shape 选择规则:
|
|
32
|
-
- 用户/角色使用 person 或 circle
|
|
33
|
-
- 前端应用使用 rectangle
|
|
34
|
-
- API/服务使用 rectangle
|
|
35
|
-
- 数据库使用 cylinder 或 sql_table
|
|
36
|
-
- 缓存使用 queue
|
|
37
|
-
- 外部服务使用 package
|
|
38
|
-
- 负载均衡器使用 diamond
|
|
39
|
-
|
|
40
|
-
示例结构:
|
|
41
|
-
用户 -> 前端 -> API网关 -> 微服务 -> 数据库
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### 2. 流程图 Prompt
|
|
45
|
-
```
|
|
46
|
-
请使用 D2 语法绘制流程图,严格按照以下 shape 约定:
|
|
47
|
-
- 开始/结束节点:oval
|
|
48
|
-
- 处理步骤:rectangle
|
|
49
|
-
- 判断节点:diamond
|
|
50
|
-
- 输入/输出:parallelogram
|
|
51
|
-
- 准备步骤:hexagon
|
|
52
|
-
- 文档生成:document
|
|
53
|
-
- 数据存储:cylinder
|
|
54
|
-
|
|
55
|
-
连接线使用箭头表示流向,判断节点要标注 yes/no 分支。
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### 3. 数据流图 Prompt
|
|
59
|
-
```
|
|
60
|
-
使用 D2 绘制数据流图,shape 选择原则:
|
|
61
|
-
- 外部实体:square
|
|
62
|
-
- 数据处理:circle
|
|
63
|
-
- 数据存储:stored_data 或 cylinder
|
|
64
|
-
- 数据流:带标签的箭头连接
|
|
65
|
-
- 数据文件:document
|
|
66
|
-
|
|
67
|
-
确保数据流方向清晰,标注数据类型和流向。
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### 4. 组织架构图 Prompt
|
|
71
|
-
```
|
|
72
|
-
创建组织架构图,使用以下 D2 shape 规范:
|
|
73
|
-
- 高层管理:person (设置较大尺寸)
|
|
74
|
-
- 部门负责人:person
|
|
75
|
-
- 团队/部门:package
|
|
76
|
-
- 具体角色:circle
|
|
77
|
-
- 外部合作方:rectangle (虚线边框)
|
|
78
|
-
|
|
79
|
-
使用层次布局,体现汇报关系。
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
## 三、通用优化 Prompt 模板
|
|
83
|
-
|
|
84
|
-
### 基础模板
|
|
85
|
-
```
|
|
86
|
-
请使用 D2 语法创建 [图表类型],要求:
|
|
87
|
-
|
|
88
|
-
1. **Shape 选择原则**:
|
|
89
|
-
- 根据元素功能选择最合适的 shape
|
|
90
|
-
- 保持同类元素使用相同 shape
|
|
91
|
-
- 重要元素可以使用特殊 shape 突出
|
|
92
|
-
|
|
93
|
-
2. **样式要求**:
|
|
94
|
-
- 使用合适的颜色区分不同类型的元素
|
|
95
|
-
- 重要路径使用加粗或特殊颜色
|
|
96
|
-
- 添加适当的标签和注释
|
|
97
|
-
|
|
98
|
-
3. **布局优化**:
|
|
99
|
-
- 使用合理的布局算法 (dagre, elk等)
|
|
100
|
-
- 避免连线交叉
|
|
101
|
-
- 保持整体美观和可读性
|
|
102
|
-
|
|
103
|
-
4. **语法规范**:
|
|
104
|
-
- 使用正确的 D2 语法
|
|
105
|
-
- 节点命名简洁明了
|
|
106
|
-
- 连接关系清晰表达
|
|
107
|
-
|
|
108
|
-
请提供完整的 D2 代码。
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### 高级定制模板
|
|
112
|
-
```
|
|
113
|
-
创建专业级 D2 图表,具体要求:
|
|
114
|
-
|
|
115
|
-
**图表信息**:[描述你要创建的图表]
|
|
116
|
-
|
|
117
|
-
**定制要求**:
|
|
118
|
-
1. **Shape 策略**:
|
|
119
|
-
- 为每种元素类型指定最佳 shape
|
|
120
|
-
- 列出 shape 选择理由
|
|
121
|
-
- 确保视觉一致性
|
|
122
|
-
|
|
123
|
-
2. **颜色方案**:
|
|
124
|
-
- 使用企业级配色
|
|
125
|
-
- 不同模块用不同颜色区分
|
|
126
|
-
- 突出关键路径
|
|
127
|
-
|
|
128
|
-
3. **高级功能**:
|
|
129
|
-
- 添加图标 (如需要)
|
|
130
|
-
- 使用容器分组相关元素
|
|
131
|
-
- 添加交互提示 (tooltip)
|
|
132
|
-
|
|
133
|
-
4. **性能考虑**:
|
|
134
|
-
- 节点数量控制在合理范围
|
|
135
|
-
- 避免过于复杂的嵌套
|
|
136
|
-
|
|
137
|
-
输出格式:
|
|
138
|
-
- D2 代码
|
|
139
|
-
- Shape 选择说明
|
|
140
|
-
- 使用建议
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
## 四、特定场景 Prompt 示例
|
|
144
|
-
|
|
145
|
-
### 网络拓扑图
|
|
146
|
-
```
|
|
147
|
-
绘制网络拓扑图,shape 使用规范:
|
|
148
|
-
- 路由器:diamond
|
|
149
|
-
- 交换机:rectangle
|
|
150
|
-
- 服务器:rectangle (填充色)
|
|
151
|
-
- 终端设备:circle
|
|
152
|
-
- 防火墙:hexagon
|
|
153
|
-
- 云服务:package
|
|
154
|
-
- 网络连接:实线
|
|
155
|
-
- 无线连接:虚线
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### 微服务架构图
|
|
159
|
-
```
|
|
160
|
-
设计微服务架构图:
|
|
161
|
-
- API Gateway:diamond
|
|
162
|
-
- 微服务:rectangle
|
|
163
|
-
- 数据库:cylinder
|
|
164
|
-
- 缓存:queue
|
|
165
|
-
- 消息队列:queue (不同颜色)
|
|
166
|
-
- 负载均衡:parallelogram
|
|
167
|
-
- 监控服务:circle
|
|
168
|
-
- 外部服务:package (虚线边框)
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### 业务流程图
|
|
172
|
-
```
|
|
173
|
-
业务流程建模:
|
|
174
|
-
- 开始事件:oval (绿色)
|
|
175
|
-
- 结束事件:oval (红色)
|
|
176
|
-
- 用户任务:rectangle
|
|
177
|
-
- 系统任务:rectangle (不同颜色)
|
|
178
|
-
- 网关决策:diamond
|
|
179
|
-
- 并行网关:diamond (特殊标记)
|
|
180
|
-
- 数据对象:document
|
|
181
|
-
- 消息流:虚线箭头
|
|
182
|
-
```
|