cgraphx 1.1.0 → 1.3.0
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/README.md +0 -1
- package/dist/.claude-template/hooks/precommit-check/precommit-check.cjs +90 -0
- package/dist/.claude-template/skills/cgraphx/SKILL.md +3 -3
- package/dist/.claude-template/skills/cgraphx/agent-prompt.md +1 -1
- package/dist/.claude-template/skills/cgraphx-guide/SKILL.md +94 -0
- package/dist/.claude-template/skills/cgraphx-guide/how-to-use.html +424 -0
- package/dist/.claude-template/skills/clarify-requirements/SKILL.md +19 -8
- package/dist/.claude-template/skills/code-impact-docgen/SKILL.md +186 -176
- package/dist/.claude-template/skills/code-impact-docgen/template-design-html.md +357 -0
- package/dist/.claude-template/skills/code-impact-docgen/template-design-md.md +164 -0
- package/dist/.claude-template/skills/code-impact-init/SKILL.md +47 -47
- package/dist/.claude-template/skills/developer-timeline/SKILL.md +9 -0
- package/dist/.claude-template/skills/precommit-review/SKILL.md +50 -0
- package/dist/.claude-template/skills/run-api-test/SKILL.md +187 -0
- package/dist/.claude-template/skills/run-api-test/assets/template-test-report.md +103 -0
- package/dist/.claude-template/skills/run-api-test/assets/template-test-verify.jsonl +5 -0
- package/dist/.claude-template/skills/run-api-test/references/bru-run.md +60 -0
- package/dist/.claude-template/skills/run-api-test/references/db-verification.md +81 -0
- package/dist/.claude-template/skills/run-api-test/references/report-format.md +104 -0
- package/dist/.claude-template/skills/run-api-test/references/service-readiness.md +61 -0
- package/dist/.claude-template/skills/run-api-test/references/test-scope.md +64 -0
- package/dist/.claude-template/skills/write-api/SKILL.md +150 -0
- package/dist/.claude-template/skills/write-api/assets/template-api-spec.md +112 -0
- package/dist/.claude-template/skills/write-api/assets/template-request.bru +75 -0
- package/dist/.claude-template/skills/write-api/references/ai-prompts.md +133 -0
- package/dist/.claude-template/skills/write-api/references/api-spec-format.md +108 -0
- package/dist/.claude-template/skills/write-api/references/bru-format.md +144 -0
- package/dist/.claude-template/skills/write-api/references/collection-layout.md +81 -0
- package/dist/.claude-template/skills/write-api/references/environment-setup.md +105 -0
- package/dist/.claude-template/skills/write-api/references/interface-scope.md +74 -0
- package/dist/.claude-template/skills/write-api-doc/SKILL.md +317 -0
- package/dist/.claude-template/skills/write-api-doc/template-api-html.md +422 -0
- package/dist/.claude-template/skills/write-plan/SKILL.md +38 -16
- package/dist/.claude-template/skills/write-prd/SKILL.md +32 -8
- package/dist/.claude-template/skills/write-spec/SKILL.md +34 -9
- package/dist/api-test/ai-fields.d.ts +37 -0
- package/dist/api-test/ai-fields.d.ts.map +1 -0
- package/dist/api-test/ai-fields.js +114 -0
- package/dist/api-test/ai-fields.js.map +1 -0
- package/dist/api-test/assemble.d.ts +76 -0
- package/dist/api-test/assemble.d.ts.map +1 -0
- package/dist/api-test/assemble.js +185 -0
- package/dist/api-test/assemble.js.map +1 -0
- package/dist/api-test/bru-cli-invoker.d.ts +72 -0
- package/dist/api-test/bru-cli-invoker.d.ts.map +1 -0
- package/dist/api-test/bru-cli-invoker.js +169 -0
- package/dist/api-test/bru-cli-invoker.js.map +1 -0
- package/dist/api-test/bru-report-parser.d.ts +24 -0
- package/dist/api-test/bru-report-parser.d.ts.map +1 -0
- package/dist/api-test/bru-report-parser.js +110 -0
- package/dist/api-test/bru-report-parser.js.map +1 -0
- package/dist/api-test/bru-runner.d.ts +101 -0
- package/dist/api-test/bru-runner.d.ts.map +1 -0
- package/dist/api-test/bru-runner.js +316 -0
- package/dist/api-test/bru-runner.js.map +1 -0
- package/dist/api-test/bru-writer.d.ts +52 -0
- package/dist/api-test/bru-writer.d.ts.map +1 -0
- package/dist/api-test/bru-writer.js +159 -0
- package/dist/api-test/bru-writer.js.map +1 -0
- package/dist/api-test/call-chain-extractor.d.ts +80 -0
- package/dist/api-test/call-chain-extractor.d.ts.map +1 -0
- package/dist/api-test/call-chain-extractor.js +179 -0
- package/dist/api-test/call-chain-extractor.js.map +1 -0
- package/dist/api-test/cli.d.ts +133 -0
- package/dist/api-test/cli.d.ts.map +1 -0
- package/dist/api-test/cli.js +1009 -0
- package/dist/api-test/cli.js.map +1 -0
- package/dist/api-test/config.d.ts +75 -0
- package/dist/api-test/config.d.ts.map +1 -0
- package/dist/api-test/config.js +406 -0
- package/dist/api-test/config.js.map +1 -0
- package/dist/api-test/db-query-cli.d.ts +51 -0
- package/dist/api-test/db-query-cli.d.ts.map +1 -0
- package/dist/api-test/db-query-cli.js +119 -0
- package/dist/api-test/db-query-cli.js.map +1 -0
- package/dist/api-test/enhance-prepare.d.ts +111 -0
- package/dist/api-test/enhance-prepare.d.ts.map +1 -0
- package/dist/api-test/enhance-prepare.js +425 -0
- package/dist/api-test/enhance-prepare.js.map +1 -0
- package/dist/api-test/enhance-write.d.ts +28 -0
- package/dist/api-test/enhance-write.d.ts.map +1 -0
- package/dist/api-test/enhance-write.js +145 -0
- package/dist/api-test/enhance-write.js.map +1 -0
- package/dist/api-test/errors.d.ts +48 -0
- package/dist/api-test/errors.d.ts.map +1 -0
- package/dist/api-test/errors.js +76 -0
- package/dist/api-test/errors.js.map +1 -0
- package/dist/api-test/field-extractor.d.ts +98 -0
- package/dist/api-test/field-extractor.d.ts.map +1 -0
- package/dist/api-test/field-extractor.js +327 -0
- package/dist/api-test/field-extractor.js.map +1 -0
- package/dist/api-test/impl-finder.d.ts +37 -0
- package/dist/api-test/impl-finder.d.ts.map +1 -0
- package/dist/api-test/impl-finder.js +54 -0
- package/dist/api-test/impl-finder.js.map +1 -0
- package/dist/api-test/index.d.ts +41 -0
- package/dist/api-test/index.d.ts.map +1 -0
- package/dist/api-test/index.js +124 -0
- package/dist/api-test/index.js.map +1 -0
- package/dist/api-test/java-parser.d.ts +89 -0
- package/dist/api-test/java-parser.d.ts.map +1 -0
- package/dist/api-test/java-parser.js +508 -0
- package/dist/api-test/java-parser.js.map +1 -0
- package/dist/api-test/md-writer.d.ts +49 -0
- package/dist/api-test/md-writer.d.ts.map +1 -0
- package/dist/api-test/md-writer.js +202 -0
- package/dist/api-test/md-writer.js.map +1 -0
- package/dist/api-test/parser-httpservice.d.ts +91 -0
- package/dist/api-test/parser-httpservice.d.ts.map +1 -0
- package/dist/api-test/parser-httpservice.js +271 -0
- package/dist/api-test/parser-httpservice.js.map +1 -0
- package/dist/api-test/report.d.ts +188 -0
- package/dist/api-test/report.d.ts.map +1 -0
- package/dist/api-test/report.js +522 -0
- package/dist/api-test/report.js.map +1 -0
- package/dist/api-test/snapshot.d.ts +26 -0
- package/dist/api-test/snapshot.d.ts.map +1 -0
- package/dist/api-test/snapshot.js +150 -0
- package/dist/api-test/snapshot.js.map +1 -0
- package/dist/api-test/test-history.d.ts +48 -0
- package/dist/api-test/test-history.d.ts.map +1 -0
- package/dist/api-test/test-history.js +122 -0
- package/dist/api-test/test-history.js.map +1 -0
- package/dist/api-test/types.d.ts +174 -0
- package/dist/api-test/types.d.ts.map +1 -0
- package/dist/api-test/types.js +13 -0
- package/dist/api-test/types.js.map +1 -0
- package/dist/api-test/verify-prepare.d.ts +30 -0
- package/dist/api-test/verify-prepare.d.ts.map +1 -0
- package/dist/api-test/verify-prepare.js +150 -0
- package/dist/api-test/verify-prepare.js.map +1 -0
- package/dist/api-test/verify-write.d.ts +31 -0
- package/dist/api-test/verify-write.d.ts.map +1 -0
- package/dist/api-test/verify-write.js +159 -0
- package/dist/api-test/verify-write.js.map +1 -0
- package/dist/bin/codegraph.js +0 -100
- package/dist/bin/codegraph.js.map +1 -1
- package/dist/dbquery/dump-schema.d.ts +46 -0
- package/dist/dbquery/dump-schema.d.ts.map +1 -0
- package/dist/dbquery/dump-schema.js +379 -0
- package/dist/dbquery/dump-schema.js.map +1 -0
- package/dist/installer/targets/claude.d.ts +15 -0
- package/dist/installer/targets/claude.d.ts.map +1 -1
- package/dist/installer/targets/claude.js +53 -0
- package/dist/installer/targets/claude.js.map +1 -1
- package/dist/resolution/index.d.ts.map +1 -1
- package/dist/resolution/index.js +13 -0
- package/dist/resolution/index.js.map +1 -1
- package/dist/resolution/scope-index.d.ts +86 -0
- package/dist/resolution/scope-index.d.ts.map +1 -0
- package/dist/resolution/scope-index.js +143 -0
- package/dist/resolution/scope-index.js.map +1 -0
- package/dist/resolution/stdlib-blocklist.d.ts +53 -0
- package/dist/resolution/stdlib-blocklist.d.ts.map +1 -0
- package/dist/resolution/stdlib-blocklist.js +143 -0
- package/dist/resolution/stdlib-blocklist.js.map +1 -0
- package/dist/search/ast-helpers.d.ts +42 -0
- package/dist/search/ast-helpers.d.ts.map +1 -0
- package/dist/search/ast-helpers.js +106 -0
- package/dist/search/ast-helpers.js.map +1 -0
- package/dist/search/call-sites.d.ts +398 -0
- package/dist/search/call-sites.d.ts.map +1 -0
- package/dist/search/call-sites.js +1433 -0
- package/dist/search/call-sites.js.map +1 -0
- package/dist/search/context.d.ts +134 -0
- package/dist/search/context.d.ts.map +1 -0
- package/dist/search/context.js +575 -0
- package/dist/search/context.js.map +1 -0
- package/dist/search/impact.d.ts +139 -0
- package/dist/search/impact.d.ts.map +1 -0
- package/dist/search/impact.js +646 -0
- package/dist/search/impact.js.map +1 -0
- package/dist/search/related.d.ts +178 -0
- package/dist/search/related.d.ts.map +1 -0
- package/dist/search/related.js +667 -0
- package/dist/search/related.js.map +1 -0
- package/dist/search/slice.d.ts +148 -0
- package/dist/search/slice.d.ts.map +1 -0
- package/dist/search/slice.js +460 -0
- package/dist/search/slice.js.map +1 -0
- package/dist/search/snr-constants.d.ts +41 -0
- package/dist/search/snr-constants.d.ts.map +1 -0
- package/dist/search/snr-constants.js +44 -0
- package/dist/search/snr-constants.js.map +1 -0
- package/dist/search/types.d.ts +28 -0
- package/dist/search/types.d.ts.map +1 -0
- package/dist/search/types.js +12 -0
- package/dist/search/types.js.map +1 -0
- package/dist/timeline/cli.d.ts.map +1 -1
- package/dist/timeline/cli.js +22 -3
- package/dist/timeline/cli.js.map +1 -1
- package/dist/timeline/store.d.ts +5 -0
- package/dist/timeline/store.d.ts.map +1 -1
- package/dist/timeline/store.js +23 -3
- package/dist/timeline/store.js.map +1 -1
- package/package.json +1 -1
- package/scripts/agent-eval/subagent-token-cost.py +188 -0
- package/dist/.claude-template/skills/code-impact-docgen/template-business-html.md +0 -242
- package/dist/.claude-template/skills/code-impact-docgen/template-business-md.md +0 -107
- package/dist/.claude-template/skills/code-impact-docgen/template-technical-html.md +0 -205
- package/dist/.claude-template/skills/code-impact-docgen/template-technical-md.md +0 -155
|
@@ -1,205 +0,0 @@
|
|
|
1
|
-
# Technical 文档 HTML 模板
|
|
2
|
-
|
|
3
|
-
适用于面向技术读者的 HTML 格式文档。
|
|
4
|
-
|
|
5
|
-
与 Business HTML 模板共享基础 CSS 样式,但增加技术文档专属样式和不同的章节结构。生成前先阅读 [template-business-html.md](template-business-html.md) 获取基础 CSS,在此基础上追加以下额外样式。
|
|
6
|
-
|
|
7
|
-
## 追加 CSS
|
|
8
|
-
|
|
9
|
-
在 Business HTML 的 `<style>` 基础上追加:
|
|
10
|
-
|
|
11
|
-
```css
|
|
12
|
-
.diagram {
|
|
13
|
-
background: var(--surface);
|
|
14
|
-
border: 1px solid var(--border);
|
|
15
|
-
border-radius: 8px;
|
|
16
|
-
padding: 1.5em;
|
|
17
|
-
margin-bottom: 1em;
|
|
18
|
-
font-family: var(--font-mono);
|
|
19
|
-
font-size: 0.875em;
|
|
20
|
-
white-space: pre;
|
|
21
|
-
overflow-x: auto;
|
|
22
|
-
line-height: 1.5;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
.tag {
|
|
26
|
-
display: inline-block;
|
|
27
|
-
font-size: 0.8em;
|
|
28
|
-
background: var(--accent-light);
|
|
29
|
-
color: var(--accent);
|
|
30
|
-
border: 1px solid rgba(0, 113, 227, 0.2);
|
|
31
|
-
padding: 0.15em 0.6em;
|
|
32
|
-
border-radius: 12px;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
.api-method {
|
|
36
|
-
font-family: var(--font-mono);
|
|
37
|
-
font-weight: 600;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
.decision-block {
|
|
41
|
-
background: var(--surface);
|
|
42
|
-
border: 1px solid var(--border);
|
|
43
|
-
border-radius: 8px;
|
|
44
|
-
padding: 1em 1.5em;
|
|
45
|
-
margin-bottom: 1em;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
.decision-block h4 {
|
|
49
|
-
margin-top: 0;
|
|
50
|
-
margin-bottom: 0.5em;
|
|
51
|
-
color: var(--accent);
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
.decision-block dl {
|
|
55
|
-
display: grid;
|
|
56
|
-
grid-template-columns: auto 1fr;
|
|
57
|
-
gap: 0.3em 1em;
|
|
58
|
-
font-size: 0.95em;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
.decision-block dt {
|
|
62
|
-
font-weight: 600;
|
|
63
|
-
color: var(--text-secondary);
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
.decision-block dd {
|
|
67
|
-
margin: 0;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
.limit-table td:first-child {
|
|
71
|
-
white-space: nowrap;
|
|
72
|
-
font-weight: 600;
|
|
73
|
-
color: var(--text-secondary);
|
|
74
|
-
}
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
## 完整 HTML 结构
|
|
78
|
-
|
|
79
|
-
```html
|
|
80
|
-
<!DOCTYPE html>
|
|
81
|
-
<html lang="zh-CN">
|
|
82
|
-
<head>
|
|
83
|
-
<meta charset="UTF-8">
|
|
84
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
85
|
-
<title>{文档标题} — {项目名称}</title>
|
|
86
|
-
<style>
|
|
87
|
-
/* 基础样式:复制 template-business-html.md 的完整 CSS */
|
|
88
|
-
/* 然后追加上述额外 CSS */
|
|
89
|
-
</style>
|
|
90
|
-
</head>
|
|
91
|
-
<body>
|
|
92
|
-
<div class="container">
|
|
93
|
-
<h1>{文档标题}</h1>
|
|
94
|
-
<p class="meta">生成日期:YYYY-MM-DD | 主题范围:{范围描述}</p>
|
|
95
|
-
|
|
96
|
-
<nav class="toc">
|
|
97
|
-
<h3>目录</h3>
|
|
98
|
-
<ul>
|
|
99
|
-
<li><a href="#概述">概述</a></li>
|
|
100
|
-
<li><a href="#架构设计">架构设计</a></li>
|
|
101
|
-
<li><a href="#核心模块">核心模块</a>
|
|
102
|
-
<ul>
|
|
103
|
-
<li><a href="#模块A">模块 A</a></li>
|
|
104
|
-
<li><a href="#模块B">模块 B</a></li>
|
|
105
|
-
</ul>
|
|
106
|
-
</li>
|
|
107
|
-
<li><a href="#技术决策">技术决策</a></li>
|
|
108
|
-
<li><a href="#已知限制">已知限制</a></li>
|
|
109
|
-
<li><a href="#扩展方向">扩展方向</a></li>
|
|
110
|
-
</ul>
|
|
111
|
-
</nav>
|
|
112
|
-
|
|
113
|
-
<article>
|
|
114
|
-
<section id="概述">
|
|
115
|
-
<h2>概述</h2>
|
|
116
|
-
<p>系统概述和技术定位。</p>
|
|
117
|
-
</section>
|
|
118
|
-
|
|
119
|
-
<section id="架构设计">
|
|
120
|
-
<h2>架构设计</h2>
|
|
121
|
-
<p>系统架构和数据流描述。</p>
|
|
122
|
-
<pre class="diagram">组件 A ──→ 组件 B ──→ 组件 C
|
|
123
|
-
│
|
|
124
|
-
↕
|
|
125
|
-
外部服务</pre>
|
|
126
|
-
</section>
|
|
127
|
-
|
|
128
|
-
<section id="核心模块">
|
|
129
|
-
<h2>核心模块</h2>
|
|
130
|
-
|
|
131
|
-
<section id="模块A">
|
|
132
|
-
<h3>模块 A</h3>
|
|
133
|
-
<p>职责描述和关键接口。</p>
|
|
134
|
-
</section>
|
|
135
|
-
|
|
136
|
-
<section id="模块B">
|
|
137
|
-
<h3>模块 B</h3>
|
|
138
|
-
<p>职责描述和关键接口。</p>
|
|
139
|
-
</section>
|
|
140
|
-
</section>
|
|
141
|
-
|
|
142
|
-
<section id="技术决策">
|
|
143
|
-
<h2>技术决策</h2>
|
|
144
|
-
<div class="decision-block">
|
|
145
|
-
<h4>决策标题</h4>
|
|
146
|
-
<dl>
|
|
147
|
-
<dt>选择</dt>
|
|
148
|
-
<dd>xxx</dd>
|
|
149
|
-
<dt>原因</dt>
|
|
150
|
-
<dd>xxx</dd>
|
|
151
|
-
<dt>替代方案</dt>
|
|
152
|
-
<dd>xxx</dd>
|
|
153
|
-
</dl>
|
|
154
|
-
</div>
|
|
155
|
-
</section>
|
|
156
|
-
|
|
157
|
-
<section id="已知限制">
|
|
158
|
-
<h2>已知限制</h2>
|
|
159
|
-
<table class="limit-table">
|
|
160
|
-
<thead>
|
|
161
|
-
<tr><th>限制</th><th>影响范围</th><th>应对措施</th></tr>
|
|
162
|
-
</thead>
|
|
163
|
-
<tbody>
|
|
164
|
-
<tr><td>限制描述</td><td>影响范围</td><td>应对措施</td></tr>
|
|
165
|
-
</tbody>
|
|
166
|
-
</table>
|
|
167
|
-
</section>
|
|
168
|
-
|
|
169
|
-
<section id="扩展方向">
|
|
170
|
-
<h2>扩展方向</h2>
|
|
171
|
-
<ol>
|
|
172
|
-
<li><strong>方向 A</strong> — 描述和优先级</li>
|
|
173
|
-
<li><strong>方向 B</strong> — 描述和优先级</li>
|
|
174
|
-
</ol>
|
|
175
|
-
</section>
|
|
176
|
-
</article>
|
|
177
|
-
</div>
|
|
178
|
-
</body>
|
|
179
|
-
</html>
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
## Technical HTML 章节内容指南
|
|
183
|
-
|
|
184
|
-
| 章节 | 内容来源 | 改写方向 |
|
|
185
|
-
|------|------------------------|----------|
|
|
186
|
-
| 概述 | Summary 文本 | 保留技术精确度,增加架构上下文 |
|
|
187
|
-
| 架构设计 | Summary 文本 + Read 文件原文 | 补充系统级架构图(文本框图)、数据流描述 |
|
|
188
|
-
| 核心模块 | Summary 文本 + Read 文件原文 | 按模块分组,说明职责和交互关系 |
|
|
189
|
-
| 数据模型 | Read 文件原文(该章节 cgraphx 不提取) | 用表格展示节点类型、属性、关系 |
|
|
190
|
-
| 技术决策 | Read 文件原文(该章节 cgraphx 不提取) | 保留决策理由,补充替代方案对比 |
|
|
191
|
-
| API 参考 | Read 文件原文(该章节 cgraphx 不提取) | 按 endpoint 分组,包含请求/响应示例 |
|
|
192
|
-
| 性能特征 | Read 文件原文(该章节 cgraphx 不提取) | 用表格展示瓶颈和优化方向 |
|
|
193
|
-
| 已知限制 | Read 文件原文(该章节 cgraphx 不提取) | 按严重程度排序,说明影响范围 |
|
|
194
|
-
| 扩展方向 | Read 文件原文(该章节 cgraphx 不提取) | 按优先级排序,说明实现复杂度 |
|
|
195
|
-
| 运维指南 | Read 文件原文(该章节 cgraphx 不提取) | 按"部署 / 监控 / 排障"分组 |
|
|
196
|
-
|
|
197
|
-
## HTML 格式要点
|
|
198
|
-
|
|
199
|
-
- 继承 Business HTML 的所有格式要点
|
|
200
|
-
- 架构图使用 `<pre class="diagram">` 包裹 ASCII 文本框图
|
|
201
|
-
- 技术决策使用 `<div class="decision-block">` 结构,包含 `<dl>` 列表
|
|
202
|
-
- 已知限制使用表格,按严重程度降序排列
|
|
203
|
-
- 模块描述使用 `<section id="模块名">` + `<h3>` 子标题
|
|
204
|
-
- API 端点使用 `<span class="api-method">GET</span>` 标注 HTTP 方法
|
|
205
|
-
- 技术标签使用 `<span class="tag">标签名</span>` 样式
|
|
@@ -1,155 +0,0 @@
|
|
|
1
|
-
# Technical 文档 Markdown 模板
|
|
2
|
-
|
|
3
|
-
适用于面向技术读者的 Markdown 格式文档。
|
|
4
|
-
|
|
5
|
-
## 文档结构
|
|
6
|
-
|
|
7
|
-
```markdown
|
|
8
|
-
# {文档标题}
|
|
9
|
-
|
|
10
|
-
> 生成日期:YYYY-MM-DD | 主题范围:{范围描述}
|
|
11
|
-
|
|
12
|
-
## 目录
|
|
13
|
-
|
|
14
|
-
- [概述](#概述)
|
|
15
|
-
- [架构设计](#架构设计)
|
|
16
|
-
- [核心模块](#核心模块)
|
|
17
|
-
- [模块 A](#模块-a)
|
|
18
|
-
- [模块 B](#模块-b)
|
|
19
|
-
- [技术决策](#技术决策)
|
|
20
|
-
- [已知限制](#已知限制)
|
|
21
|
-
- [扩展方向](#扩展方向)
|
|
22
|
-
|
|
23
|
-
## 概述
|
|
24
|
-
|
|
25
|
-
系统概述和技术定位。
|
|
26
|
-
|
|
27
|
-
## 架构设计
|
|
28
|
-
|
|
29
|
-
系统架构和数据流描述。
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
组件 A ──→ 组件 B ──→ 组件 C
|
|
33
|
-
│
|
|
34
|
-
↕
|
|
35
|
-
外部服务
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## 核心模块
|
|
39
|
-
|
|
40
|
-
### 模块 A
|
|
41
|
-
|
|
42
|
-
职责描述、关键接口和依赖关系。
|
|
43
|
-
|
|
44
|
-
### 模块 B
|
|
45
|
-
|
|
46
|
-
职责描述、关键接口和依赖关系。
|
|
47
|
-
|
|
48
|
-
## 技术决策
|
|
49
|
-
|
|
50
|
-
### 决策标题
|
|
51
|
-
|
|
52
|
-
- **选择**:xxx
|
|
53
|
-
- **原因**:xxx
|
|
54
|
-
- **替代方案**:xxx
|
|
55
|
-
|
|
56
|
-
## 已知限制
|
|
57
|
-
|
|
58
|
-
| 限制 | 影响范围 | 应对措施 |
|
|
59
|
-
|------|----------|----------|
|
|
60
|
-
| 限制描述 | 影响范围 | 应对措施 |
|
|
61
|
-
|
|
62
|
-
## 扩展方向
|
|
63
|
-
|
|
64
|
-
1. **方向 A** — 描述和优先级
|
|
65
|
-
2. **方向 B** — 描述和优先级
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## 可选章节(按需插入)
|
|
69
|
-
|
|
70
|
-
```markdown
|
|
71
|
-
## 数据模型
|
|
72
|
-
|
|
73
|
-
| 类型 | 属性 | 关系 |
|
|
74
|
-
|------|------|------|
|
|
75
|
-
| 节点类型 A | 属性列表 | 关系列表 |
|
|
76
|
-
|
|
77
|
-
## API 参考
|
|
78
|
-
|
|
79
|
-
### 端点名称
|
|
80
|
-
|
|
81
|
-
`POST /api/path`
|
|
82
|
-
|
|
83
|
-
**请求参数**:
|
|
84
|
-
|
|
85
|
-
| 参数 | 类型 | 说明 |
|
|
86
|
-
|------|------|------|
|
|
87
|
-
| param | string | 说明 |
|
|
88
|
-
|
|
89
|
-
**响应示例**:
|
|
90
|
-
|
|
91
|
-
```json
|
|
92
|
-
{
|
|
93
|
-
"key": "value"
|
|
94
|
-
}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
## 性能特征
|
|
98
|
-
|
|
99
|
-
| 瓶颈 | 影响 | 优化方向 |
|
|
100
|
-
|------|------|----------|
|
|
101
|
-
| 描述 | 影响范围 | 优化方案 |
|
|
102
|
-
|
|
103
|
-
## 运维指南
|
|
104
|
-
|
|
105
|
-
### 部署
|
|
106
|
-
|
|
107
|
-
部署步骤和注意事项。
|
|
108
|
-
|
|
109
|
-
### 监控
|
|
110
|
-
|
|
111
|
-
关键指标和告警规则。
|
|
112
|
-
|
|
113
|
-
### 故障排除
|
|
114
|
-
|
|
115
|
-
按"症状 → 原因 → 修复"格式记录。
|
|
116
|
-
|
|
117
|
-
## 术语表
|
|
118
|
-
|
|
119
|
-
| 术语 | 定义 |
|
|
120
|
-
|------|------|
|
|
121
|
-
| 术语 A | 技术定义 |
|
|
122
|
-
| 术语 B | 技术定义 |
|
|
123
|
-
|
|
124
|
-
## 相关资源
|
|
125
|
-
|
|
126
|
-
- [相关代码](相对路径)
|
|
127
|
-
- [外部文档](URL)
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
## Technical Markdown 章节内容指南
|
|
131
|
-
|
|
132
|
-
| 章节 | 内容来源 | 改写方向 |
|
|
133
|
-
|------|------------------------|----------|
|
|
134
|
-
| 概述 | Summary 文本 | 保留技术精确度,增加架构上下文 |
|
|
135
|
-
| 架构设计 | Summary 文本 + Read 文件原文 | 补充系统级架构图(代码块中的 ASCII 文本框图)、数据流描述 |
|
|
136
|
-
| 核心模块 | Summary 文本 + Read 文件原文 | 按模块分组,说明职责和交互关系 |
|
|
137
|
-
| 数据模型 | Read 文件原文(该章节 cgraphx 不提取) | 用表格展示节点类型、属性、关系 |
|
|
138
|
-
| 技术决策 | Read 文件原文(该章节 cgraphx 不提取) | 保留决策理由,补充替代方案对比,按"选择/原因/替代方案"格式 |
|
|
139
|
-
| API 参考 | Read 文件原文(该章节 cgraphx 不提取) | 按 endpoint 分组,包含请求参数表格和响应示例 |
|
|
140
|
-
| 性能特征 | Read 文件原文(该章节 cgraphx 不提取) | 用表格展示瓶颈和优化方向 |
|
|
141
|
-
| 已知限制 | Read 文件原文(该章节 cgraphx 不提取) | 按严重程度排序,用表格说明影响范围和应对措施 |
|
|
142
|
-
| 扩展方向 | Read 文件原文(该章节 cgraphx 不提取) | 按优先级排序,用编号列表说明实现复杂度 |
|
|
143
|
-
| 运维指南 | Read 文件原文(该章节 cgraphx 不提取) | 按"部署 / 监控 / 故障排除"分子章节 |
|
|
144
|
-
|
|
145
|
-
## 格式规则
|
|
146
|
-
|
|
147
|
-
- 继承 [template-business-md.md](template-business-md.md) 的所有格式规则
|
|
148
|
-
- 技术文档额外规则:
|
|
149
|
-
- 架构图使用代码块中的 ASCII 文本框图,不标注语言类型
|
|
150
|
-
- 技术决策按"选择 / 原因 / 替代方案"列表格式
|
|
151
|
-
- 代码示例标注语言类型(`rust`、`bash`、`json` 等)
|
|
152
|
-
- 文件路径使用行内代码包裹:`src/main.rs`
|
|
153
|
-
- HTTP 方法使用行内代码包裹:`POST /api/search/hybrid`
|
|
154
|
-
- 模块描述使用 `###` 子标题
|
|
155
|
-
- 表格优先用于结构化信息(限制、API 参数、性能瓶颈)
|