dsh-wiki-notes 1.3.0 → 1.4.1
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 +104 -24
- package/docs/README.md +70 -0
- package/docs//345/245/221/347/272/246-stage0/knowledge-gateway.v1.schema.json +1180 -0
- package/docs//345/245/221/347/272/246-stage0/samples/_verify_probe.json +46 -0
- package/docs//345/245/221/347/272/246-stage0/samples/context.cq-shenlun.json +612 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.context-corrupt.json +20 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.context-expired.json +20 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.fabricated-quote.json +31 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.right-with-limit.json +14 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.scope-mismatch.json +27 -0
- package/docs//345/245/221/347/272/246-stage0/samples/verify.wrong-five.json +43 -0
- package/docs//345/245/221/347/272/246-stage0//350/247/202/345/257/237/346/234/237/346/226/271/346/241/210.md +81 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2650-/345/256/241/350/256/241/344/270/216/345/245/221/347/272/246.md +204 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2651-/346/225/260/345/200/274/345/210/244/346/215/256/344/270/216/345/274/225/346/223/216/347/212/266/346/200/201.md +107 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2652-/345/277/253/347/205/247/344/270/216TTL.md +84 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2653-/346/224/257/346/214/201/345/216/237/345/233/240.md +98 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2654-/346/217/222/344/273/266/346/216/245/345/205/245.md +143 -0
- package/docs//345/245/221/347/272/246-stage0//351/230/266/346/256/2655-/350/247/202/345/257/237/351/227/255/347/216/257/344/270/216/345/256/236/346/210/230/351/252/214/346/224/266.md +109 -0
- package/lib/bridge.js +210 -0
- package/lib/client.js +1 -1
- package/lib/config.js +59 -0
- package/lib/index.js +268 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,14 +2,90 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/deepseek-ai)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**给你那堆 Markdown 笔记,接上四个能用的工具:查得到、读得出、核得住、看得见。**
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
为 [DeepSeek Harness](https://github.com/deepseek-ai) 做的只读检索插件。旧的流程是五步:读总览 → 读索引 → 敲命令搜 → 打开那页 → 追它的来源。现在一次调用就把**命中小节的完整正文 + 出处**返回,模型自己接着答。
|
|
8
8
|
|
|
9
9
|
> 中文文档从下面开始。实测:73 页的库,旧流程单次 ≈ 18.7k 字符,新流程 ≈ 2.5k。
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
+
## 目录
|
|
14
|
+
|
|
15
|
+
| 你想知道 | 直接跳 |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| 这插件到底能干什么 | [四个工具](#四个工具) |
|
|
18
|
+
| 我要先装上试试 | [装](#装) · [配](#配) |
|
|
19
|
+
| 我自己的笔记该怎么写 | [库该长什么样](#库该长什么样) |
|
|
20
|
+
| 检索为什么这么打分 | [检索质量](#检索质量) |
|
|
21
|
+
| 它有没有偷看我的东西 | [只读,且不往外发](#只读且不往外发) |
|
|
22
|
+
| 已知毛病 | [已知局限](#已知局限) |
|
|
23
|
+
| 要改代码 | [目录 / 开发](#目录--开发) |
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 四个工具
|
|
28
|
+
|
|
29
|
+
插件注册四个工具,用途不重叠,按顺序读就明白了:
|
|
30
|
+
|
|
31
|
+
| 工具 | 一句话 | 什么时候用 |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| **`wiki_recall`** | 检索库,拿到命中小节的正文与出处 | 「我的笔记里怎么写的?」 |
|
|
34
|
+
| **`wiki_context`** | 检索 + 抽证据 + 标缺口 + 给回答约束,**一次做完** | 要引用笔记原文回答,或想知道「依据够不够」 |
|
|
35
|
+
| **`wiki_verify`** | 拿已有的 context 核验一段回答,**不重新检索** | 答案写完了自查,特别是有数字的时候 |
|
|
36
|
+
| **`wiki_observe`** | 查观察日志统计(调用次数、支持状态分布、违规类型) | 诊断,不参与回答 |
|
|
37
|
+
|
|
38
|
+
### `wiki_recall` —— 检索
|
|
39
|
+
|
|
40
|
+
一个工具,七种 mode:
|
|
41
|
+
|
|
42
|
+
| mode | 干什么 | 参数 |
|
|
43
|
+
| --- | --- | --- |
|
|
44
|
+
| `search`(默认) | 关键词 AND 检索 | `query`、`limit`(5,≤12)、`sectionChars`(900,≤3000) |
|
|
45
|
+
| `page` | 按页名/别名取整页 | `name`、`pageChars`(6000) |
|
|
46
|
+
| `list` | 按类型/标签/状态列目录 | `type`、`tags`、`status`、`limit`(40,≤200) |
|
|
47
|
+
| `overview` | 总览 + 规模行 + 最近日志 + 健康计数 | `pageChars`(4000)、`logLimit`(5,≤20) |
|
|
48
|
+
| `lint` | 库健康检查:孤儿页、断链名字、缺字段、别名冲突、久未更新、无出链、草稿、index 与磁盘不一致;**并和上次体检对比,报出新增与已修** | `limit`(8,≤40)、`staleDays`(120) |
|
|
49
|
+
| `draft` | 把好答案回写成新页的落盘骨架(目录、frontmatter、index 行、log 条),不写文件 | `title`、`type`、`tags`、`summary`、`sources` |
|
|
50
|
+
| `help` | 用法与状态说明:七个 mode 各返回什么、`status` 各取值怎么读、参数默认值 | 无 |
|
|
51
|
+
|
|
52
|
+
```jsonc
|
|
53
|
+
{ "mode": "search", "query": "上下文 预算", "limit": 5 }
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
每条命中带 `kind`(note / raw-summary / source)、`sources`(来源数,**证据强度的唯一可靠代理**)、`status`、`gist`、`section`(命中小节正文,不是 90 字片段)、`citation`(`← [[页名]] §小节 → 路径`)、`brokenLinks`(指向不存在页的双链 = 「库里没依据」的硬信号),以及 `updated` 后面的**距今天数**(超过 180 天标「可能已过时」——三年前的结论和上周的长得一样,模型需要这个信号)。`overview` 额外给三项健康信号:index 有磁盘无、磁盘有 index 无、跨目录重名。
|
|
57
|
+
|
|
58
|
+
### `wiki_context` —— 带证据的上下文
|
|
59
|
+
|
|
60
|
+
要引用笔记原文回答、或需要知道「有没有依据 / 依据够不够 / 哪里是缺口」时用它,而不是自己连续调 `wiki_recall`。
|
|
61
|
+
|
|
62
|
+
参数:`query`(必填)、`limit`(1–12,默认 5)、`engine`(`both` / `search` / `wiki_recall`,默认 `both`)、`ttl_seconds`(默认 1800)。
|
|
63
|
+
|
|
64
|
+
返回里最重要的一条:**`status.support` 和 `status.degraded` 是两件事,必须分开看。**
|
|
65
|
+
|
|
66
|
+
- `support` 说的是**知识够不够**(`sufficient` / `partial` / `insufficient`)。
|
|
67
|
+
- `degraded` 说的是**引擎有没有坏**。它是布尔值,为真时说明某个检索通道挂了 —— 这时候不能把 `support` 当结论,那是拿不完整的检索结果下的判断。
|
|
68
|
+
|
|
69
|
+
同时返回 `evidence`(证据页,含分级、支撑了哪个槽位)、`missing`(缺什么、为什么缺)、`conflicts`(冲突候选,**未裁决,别当成已确认的结论**)、`answer.contract_text`(给回答的约束:必须披露缺口、不得超出证据、引文须原文),以及一个 `context_id`。
|
|
70
|
+
|
|
71
|
+
### `wiki_verify` —— 核验回答
|
|
72
|
+
|
|
73
|
+
写完答案后自查(尤其含数字、范围、年份、题量分值这类主张时)用它。参数:`context_id` + `answer`。
|
|
74
|
+
|
|
75
|
+
它不重新检索 —— 拿当初那份快照来比,所以快,也不受库里后来改动的影响。
|
|
76
|
+
|
|
77
|
+
返回 `status` 与 `violations`:violations 非空说明回答越过了证据允许的边界,每条都带类型、主张和原因。另有 `notices` 单独放「说不清」的提示 —— **「说不清」不等于「说错了」**,模型若只读 violations 会漏掉这一块。
|
|
78
|
+
|
|
79
|
+
`context_expired` / `context_missing` 是**快照问题**,不等于回答错了:重新取一份 context 再核验就行。
|
|
80
|
+
|
|
81
|
+
### `wiki_observe` —— 诊断
|
|
82
|
+
|
|
83
|
+
参数:`days`(1–365,默认 7)、`limit`(1–50,默认 10)。
|
|
84
|
+
|
|
85
|
+
报观察窗口内的调用次数、支持状态分布、检索状态分布、违规类型分布,还有**修正情况**(核验过的 context 里已改正 / 仍未改正的比例)—— 这一项比违规总数更能反映核验到底有没有用。只读诊断,不参与回答,也不改检索行为。
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
13
89
|
## 设计从哪来
|
|
14
90
|
|
|
15
91
|
库结构来自 [Karpathy 的 `llm-wiki.md`](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f):与其每次提问都从原始文档重新检索(知识不累积),不如让 LLM 增量维护一个持久的 wiki。本插件只加速其中的 **Query** 一段。
|
|
@@ -56,32 +132,16 @@ plugin_manager { action: "install_bundle", target: "<绝对路径>" }
|
|
|
56
132
|
|
|
57
133
|
没配时工具会直接告诉你「还没配置知识库路径」,不会静默扫空目录。
|
|
58
134
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
## 用
|
|
62
|
-
|
|
63
|
-
| mode | 干什么 | 参数 |
|
|
64
|
-
| --- | --- | --- |
|
|
65
|
-
| `search`(默认) | 关键词 AND 检索 | `query`、`limit`(5,≤12)、`sectionChars`(900,≤3000) |
|
|
66
|
-
| `page` | 按页名/别名取整页 | `name`、`pageChars`(6000) |
|
|
67
|
-
| `list` | 按类型/标签/状态列目录 | `type`、`tags`、`status`、`limit`(40,≤200) |
|
|
68
|
-
| `overview` | 总览 + 规模行 + 最近日志 + 健康计数 | `pageChars`(4000)、`logLimit`(5,≤20) |
|
|
69
|
-
| `lint` | 库健康检查:孤儿页、断链名字、缺字段、别名冲突、久未更新、无出链、草稿、index 与磁盘不一致;**并和上次体检对比,报出新增与已修** | `limit`(8,≤40)、`staleDays`(120) |
|
|
70
|
-
| `draft` | 把好答案回写成新页的落盘骨架(目录、frontmatter、index 行、log 条),不写文件 | `title`、`type`、`tags`、`summary`、`sources` |
|
|
71
|
-
| `help` | 用法与状态说明:七个 mode 各返回什么、`status` 各取值怎么读、参数默认值 | 无 |
|
|
135
|
+
`wiki_context` / `wiki_verify` / `wiki_observe` 还需要一条 Python 通路(`bridge.python` + `bridge.toolsRoot`,后者是含 `wiki_bridge.py` 的目录)。没配的话这三个工具会明确报 `E_PYTHON_UNAVAILABLE` —— **不会假装成「知识库里没有」**。配置形状见 [docs/契约-stage0/阶段4-插件接入.md](docs/契约-stage0/阶段4-插件接入.md)。
|
|
72
136
|
|
|
73
|
-
|
|
74
|
-
{ "mode": "search", "query": "上下文 预算", "limit": 5 }
|
|
75
|
-
```
|
|
137
|
+
---
|
|
76
138
|
|
|
77
|
-
|
|
139
|
+
## 模型怎么知道该查库
|
|
78
140
|
|
|
79
|
-
|
|
141
|
+
插件会从你库里现有的 `标签` 算出主题词,注入一行(约 50 token,例如「本地知识库主题:上下文工程、ai、agent…」)。不带页数 —— 页数一变就会打掉提示词的前缀缓存,而它对「该不该查」没有帮助。换库自动变,所以问题沾这些主题时它自己会去查,不用你提醒。设置页里可以关掉(不占上下文)、换成自己的整段、或在末尾追加一句,改完下一回合生效。
|
|
80
142
|
|
|
81
143
|
主题词怎么挑:跳过 `总览`/`index` 这类结构页,跳过 `数据`/`工具`/`meta` 这类空泛标签,默认只留出现 ≥2 次的标签(设置页可改回 ≥1)。全被滤掉时退回不过滤的前五 —— 小库不至于一条提示都没有。
|
|
82
144
|
|
|
83
|
-
> `limit` 默认 5,一次约 2.5–3k token。嫌多可以传 3 省四成,但默认留 5 —— 少一次往返比省四成更值钱。
|
|
84
|
-
|
|
85
145
|
---
|
|
86
146
|
|
|
87
147
|
## 设置页
|
|
@@ -139,6 +199,15 @@ plugin_manager { action: "install_bundle", target: "<绝对路径>" }
|
|
|
139
199
|
|
|
140
200
|
---
|
|
141
201
|
|
|
202
|
+
## 只读,且不往外发
|
|
203
|
+
|
|
204
|
+
- 插件只读你的笔记:不写库、不改页、不修红链。
|
|
205
|
+
- 检索在本地进程内跑,没有任何出站请求。
|
|
206
|
+
- `wiki_context` / `wiki_verify` 调的是**你自己机器上的** Python 管线(`bridge.toolsRoot`),同样不出网。
|
|
207
|
+
- 仓库里不含任何本机绝对路径或用户名;测试用环境变量拿真实路径(`WIKI_ROOT` / `WIKI_TOOLS`),不给就跑样例库。
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
142
211
|
## 上下游(可选)
|
|
143
212
|
|
|
144
213
|
- **进料**:[Obsidian Web Clipper](https://github.com/obsidianmd/obsidian-clipper) —— 网页剪藏成 Markdown 落进 raw 层。模板里写好 `类型` / `来源数量` / `标签`,本插件的 `kind`、`sources`、证据强度才有东西可用。
|
|
@@ -153,7 +222,10 @@ plugin_manager { action: "install_bundle", target: "<绝对路径>" }
|
|
|
153
222
|
- 每次调用全量扫描;70–100 页无所谓,再大一个数量级要上增量索引。
|
|
154
223
|
- **重启后第一次扫描是冷盘读**:95 页实测 5,217ms(此后 29ms)。插件启动就预热一次,所以这段延迟通常落在你还没提问的时候;但第一条查询正好赶上也确实要等。
|
|
155
224
|
- **面板没打开时 `/`、`Ctrl/⌘ + K` 不会有反应**:快捷键绑在面板上,而宿主的 `sidebarRightTabs` 只提供 `register()`,没有「打开 / 激活页签」的接口,插件没法从外面把面板叫出来。
|
|
156
|
-
-
|
|
225
|
+
- **知识网关那套仍是两套实现**:JS 侧 `wiki_recall` 和 Python 侧 `wiki_context` 各自解析页面,差在结构解读层。统一方向未定。
|
|
226
|
+
- **`unverifiable` 只在 `notices` 里**:模型若只看 `violations`,会漏掉「这个数字我核实不了」。
|
|
227
|
+
- **观察日志无轮转**:只追加不清理,`legacy` 计数会随时间变大。
|
|
228
|
+
- **快照不自动清理**,也没有滑动续期。
|
|
157
229
|
|
|
158
230
|
---
|
|
159
231
|
|
|
@@ -169,9 +241,11 @@ bin/cli.mjs 命令行,不装插件也能跑
|
|
|
169
241
|
tools/probe.mjs 检索质量探针:hit@1 / hit@3 / Recall@5,追加趋势 CSV
|
|
170
242
|
tools/preview.mjs 把面板渲染成静态页(真组件 + 真 CSS),改样式不必重启 DSH
|
|
171
243
|
docs/库结构.md 库结构约定(这份才是一手文档)
|
|
244
|
+
docs/README.md 文档导航页
|
|
172
245
|
docs/superpowers/specs/ 检索面板的设计稿
|
|
246
|
+
docs/契约-stage0/ 知识网关的设计与验收记录
|
|
173
247
|
examples/ 可跑的最小样例库
|
|
174
|
-
tests/ smoke / status / lint / explain / api / help / contract / watch / client bundle
|
|
248
|
+
tests/ smoke / status / lint / explain / api / help / contract / watch / client bundle / gateway
|
|
175
249
|
```
|
|
176
250
|
|
|
177
251
|
```bash
|
|
@@ -183,6 +257,12 @@ node tools/preview.mjs # 出 preview/panel.html,
|
|
|
183
257
|
node tools/preview.mjs --diag # 同上,并量一遍宽度 / 截断 / 溢出 / 对比度
|
|
184
258
|
```
|
|
185
259
|
|
|
260
|
+
跑知识网关那两段真实通路,要给两个环境变量(不给就整段跳过,不会假装通过):
|
|
261
|
+
|
|
262
|
+
```bash
|
|
263
|
+
WIKI_ROOT="/path/your/知识层-wiki" WIKI_TOOLS="/path/your/工具-tools" node tests/gateway.mjs
|
|
264
|
+
```
|
|
265
|
+
|
|
186
266
|
发版:改 `version` → `node --run test` 全绿 → `npm pack --dry-run` 看一眼打包内容(`files` 只含 `lib`/`bin`/`docs`/`examples`/`README.md`/`LICENSE`/`cordis.patch.yml`,`preview/` 与 `tools/` 不进包)→ `npm publish`。本机 npm 常是未登录状态(`npm whoami` 报 `need auth`),发布前先在浏览器里确认 token。
|
|
187
267
|
|
|
188
268
|
改样式的两条经验:
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# 文档导航
|
|
2
|
+
|
|
3
|
+
这个目录里有两类文档,混在一起容易迷路:
|
|
4
|
+
|
|
5
|
+
| 类别 | 目录 | 读者 | 什么时候看 |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| **使用类** | [库结构.md](库结构.md)、[metrics.md](metrics.md) | 库的作者、插件的使用者 | 想知道「我的笔记该怎么写」「插件到底怎么打分」 |
|
|
8
|
+
| **设计类** | [契约-stage0/](契约-stage0/) | 改插件的人、审方案的人 | 想知道「知识网关为什么长这样」「某个字段为什么这么定」 |
|
|
9
|
+
|
|
10
|
+
**只想用插件** → 读仓库根目录的 [README.md](../README.md) 就够了,这页是给要动手改的人看的。
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 使用类
|
|
15
|
+
|
|
16
|
+
### [库结构.md](库结构.md) · 163 行
|
|
17
|
+
|
|
18
|
+
**一份目录 + 一堆 `.md` 就能用**,其余全是加分项。文档按四层写:第 0 层最小可用 → 第 1 层 frontmatter 七字段 → 第 2 层 `index.md` 摘要目录 → 第 3 层 `总览-overview.md`。
|
|
19
|
+
|
|
20
|
+
想知道「`别名` 到底有什么用」「`来源数量` 为什么是证据强度的唯一代理」,看这份。
|
|
21
|
+
|
|
22
|
+
### [metrics.md](metrics.md) · 107 行
|
|
23
|
+
|
|
24
|
+
检索**一致性**指标的定义:Recall@5(micro)、Top-1 一致率、Top-5 集合一致率(Jaccard)。
|
|
25
|
+
|
|
26
|
+
文档开头有一句话值得抄下来贴在墙上:*「这些指标不回答『检索得准不准』。名字选错,后面所有人都会拿它当正确答案。」*
|
|
27
|
+
|
|
28
|
+
### [superpowers/specs/](superpowers/specs/)
|
|
29
|
+
|
|
30
|
+
`2026-11-04-wiki-search-panel-design.md` —— 检索面板的设计稿(113 行)。改面板样式前先看它。
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 设计类:契约-stage0
|
|
35
|
+
|
|
36
|
+
这一组是**知识网关**(`wiki_context` / `wiki_verify` / `wiki_observe` 三个工具)的设计与验收记录,按阶段推进,每份都以「已实现 + 已验收」的状态定稿。
|
|
37
|
+
|
|
38
|
+
| 阶段 | 文档 | 行数 | 回答什么问题 |
|
|
39
|
+
| --- | --- | --- | --- |
|
|
40
|
+
| 0 | [阶段0-审计与契约.md](契约-stage0/阶段0-审计与契约.md) | 204 | 现有能力怎么映射成契约?实测发现哪 6 个缺口(F1–F6)?错误码与超时预算怎么定? |
|
|
41
|
+
| 1 | [阶段1-数值判据与引擎状态.md](契约-stage0/阶段1-数值判据与引擎状态.md) | 107 | 「答案里的数字和库里对不上」怎么判定?引擎坏了怎么在输出里看得见? |
|
|
42
|
+
| 2 | [阶段2-快照与TTL.md](契约-stage0/阶段2-快照与TTL.md) | 84 | `wiki_verify` 不重新检索,怎么拿到当初那份证据?快照存什么、多久过期? |
|
|
43
|
+
| 3 | [阶段3-支持原因.md](契约-stage0/阶段3-支持原因.md) | 98 | `support_status` 为什么是这个值?11 个原因码分别什么意思? |
|
|
44
|
+
| 4 | [阶段4-插件接入.md](契约-stage0/阶段4-插件接入.md) | 143 | 插件怎么调 Python 桥?进程协议、文件清单、配置、降级矩阵、踩过的坑 |
|
|
45
|
+
| 5 | [阶段5-观察闭环与实战验收.md](契约-stage0/阶段5-观察闭环与实战验收.md) | 109 | 五类问题(直接事实/证据不足/范围混淆/证据冲突/错误答案)实战验收结果,三层能力对照 |
|
|
46
|
+
| — | [观察期方案.md](契约-stage0/观察期方案.md) | 81 | 真实使用中怎么观察「模型会不会用、用得对不对」?五个观察点怎么测? |
|
|
47
|
+
|
|
48
|
+
### 配套产物
|
|
49
|
+
|
|
50
|
+
- **[knowledge-gateway.v1.schema.json](契约-stage0/knowledge-gateway.v1.schema.json)** —— 契约的机器可读定义(28 KB),`context` / `verify` / `observe_stats` 三种输出的完整字段。
|
|
51
|
+
- **[samples/](契约-stage0/samples/)** —— 8 份真实样例:`context.cq-shenlun.json`(一份完整的 context)、6 份 verify 场景(答对但有缺口 / 编引文 / 范围错 / 数字错 / 快照过期 / 快照损坏)、`_verify_probe.json`。
|
|
52
|
+
改判据前,先拿样例跑一遍 `wiki_verify` 看行为有没有变。
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## 阅读顺序建议
|
|
57
|
+
|
|
58
|
+
| 你的目的 | 顺序 |
|
|
59
|
+
| --- | --- |
|
|
60
|
+
| 第一次用这个插件 | README → [库结构.md](库结构.md) |
|
|
61
|
+
| 想知道插件为什么这么打分 | README「检索质量」节 → [metrics.md](metrics.md) → 阶段 1 |
|
|
62
|
+
| 要加一个新工具 | 阶段 0 → 阶段 4 → `knowledge-gateway.v1.schema.json` |
|
|
63
|
+
| 要改判定逻辑(会拦答案的那种) | 阶段 1(数值判据)→ 阶段 3(支持原因)→ `samples/` |
|
|
64
|
+
| 要看这套东西到底行不行 | 阶段 5 → [观察期方案.md](契约-stage0/观察期方案.md) |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 一条规矩
|
|
69
|
+
|
|
70
|
+
**这些文档记的是「当时的结论」,不是「永久有效的规则」。** 每份文档末尾都有「已知局限」一节 —— 那是设计者自己写下的边界,比正文更值得读。真要改设计,先看局限那一节,多数坑已经写在纸上了。
|