truthmark 1.6.0 → 2.1.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.de.md +120 -106
- package/README.es.md +137 -123
- package/README.md +59 -45
- package/README.ru.md +109 -95
- package/README.zh.md +108 -96
- package/dist/main.js +1235 -612
- package/dist/main.js.map +1 -1
- package/package.json +1 -1
package/README.zh.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**你的代理会写代码。Truthmark
|
|
3
|
+
**你的代理会写代码。Truthmark 维护面向人、可在 Git 中审查的文档。**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | [Deutsch](README.de.md) | 中文 | [Español](README.es.md) | [Русский](README.ru.md)
|
|
6
6
|
|
|
7
7
|

|
|
8
8
|
|
|
9
|
-
AI
|
|
9
|
+
AI 编码代理改变仓库的速度,可能比人类对齐文档的速度更快。
|
|
10
10
|
|
|
11
11
|
Truthmark 修复代码写完后通常会坏掉的那一部分:仓库事实。
|
|
12
12
|
|
|
@@ -26,16 +26,16 @@ Truthmark 修复代码写完后通常会坏掉的那一部分:仓库事实。
|
|
|
26
26
|
|
|
27
27
|
AI 编码代理很擅长产出代码。这会制造一种新的失效模式。
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
实现改变了,但仓库说明开始漂移:
|
|
30
30
|
|
|
31
31
|
- 行为存在于聊天历史里
|
|
32
32
|
- 架构文档落后
|
|
33
33
|
- 产品决策在交接后消失
|
|
34
|
-
- 审查者看到代码 diff
|
|
34
|
+
- 审查者看到代码 diff,却看不到相关的事实文档 diff
|
|
35
35
|
- 分支悄悄发展出不同版本的“什么是真的”
|
|
36
|
-
-
|
|
36
|
+
- 每个代理会话都必须从头重新发现仓库事实
|
|
37
37
|
|
|
38
|
-
Truthmark
|
|
38
|
+
Truthmark 把这种脆弱的仓库事实变成已提交的仓库基础设施。
|
|
39
39
|
|
|
40
40
|
它不是依赖每个人和每个代理都记住正确的文档习惯,而是把这个习惯安装进仓库。
|
|
41
41
|
|
|
@@ -50,23 +50,23 @@ Truthmark 的正常路径是:
|
|
|
50
50
|
运行相关测试
|
|
51
51
|
Truth Sync 检查已映射的事实文档
|
|
52
52
|
需要时更新事实文档
|
|
53
|
-
人类审查代码 diff +
|
|
53
|
+
人类审查代码 diff + 事实文档 diff
|
|
54
54
|
提交或交接
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
核心价值是:**AI 工作更容易被信任,因为仓库仍然清晰可读。**
|
|
58
58
|
|
|
59
|
-
##
|
|
59
|
+
## 两个接口,一个事实系统
|
|
60
60
|
|
|
61
61
|
Truthmark 不只是一个 CLI。
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
它有两个不同接口,这个区别很重要。
|
|
64
64
|
|
|
65
65
|
### 1. 面向人的 CLI
|
|
66
66
|
|
|
67
67
|
CLI 面向维护者、审查者和自动化。
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
用它来配置仓库、安装或刷新工作流文件、验证事实产物,并生成可选的审查材料。
|
|
70
70
|
|
|
71
71
|
```bash
|
|
72
72
|
truthmark config
|
|
@@ -78,11 +78,11 @@ CLI 会准备并验证仓库环境。
|
|
|
78
78
|
|
|
79
79
|
它不是 AI 工作流运行时。
|
|
80
80
|
|
|
81
|
-
### 2. 面向 AI
|
|
81
|
+
### 2. 面向 AI 的工作流接口
|
|
82
82
|
|
|
83
|
-
面向 AI
|
|
83
|
+
面向 AI 的接口是给编码代理使用的。
|
|
84
84
|
|
|
85
|
-
Truthmark
|
|
85
|
+
Truthmark 会安装宿主原生的技能、提示、命令、受管指令块和受支持的子代理接口,让 AI 代理能在正常编码工具中遵循仓库专属的事实工作流。
|
|
86
86
|
|
|
87
87
|
示例:
|
|
88
88
|
|
|
@@ -101,7 +101,7 @@ Truthmark 会安装宿主原生的技能、提示、命令、受管说明块和
|
|
|
101
101
|
|
|
102
102
|
它们是面向 AI 的工作流入口。
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
这种拆分正是 Truthmark 的产品边界:
|
|
105
105
|
|
|
106
106
|
```text
|
|
107
107
|
人类拥有仓库契约
|
|
@@ -142,7 +142,7 @@ truthmark config
|
|
|
142
142
|
|
|
143
143
|
继续之前先审查这个文件。它定义仓库中已提交的层级契约。
|
|
144
144
|
|
|
145
|
-
###
|
|
145
|
+
### 安装工作流接口
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
148
|
truthmark init
|
|
@@ -152,8 +152,10 @@ truthmark init
|
|
|
152
152
|
|
|
153
153
|
- 路由文件
|
|
154
154
|
- 事实文档脚手架
|
|
155
|
-
-
|
|
156
|
-
- 已配置平台的面向 AI
|
|
155
|
+
- 受管指令块
|
|
156
|
+
- 已配置平台的面向 AI 工作流接口
|
|
157
|
+
|
|
158
|
+
默认事实文档模板的依据见 [Template Standards](docs/standards/template-standards.md)。该文档说明这些模板如何对齐 ISO/IEC/IEEE 42010、ISO/IEC/IEEE 29148、ISO/IEC/IEEE 12207、ISO/IEC 25010、C4、arc42、OpenAPI、SemVer、Google SRE 和 Diátaxis 等公认软件工程参考。
|
|
157
159
|
|
|
158
160
|
### 验证设置
|
|
159
161
|
|
|
@@ -163,9 +165,7 @@ truthmark check
|
|
|
163
165
|
|
|
164
166
|
然后在提交前审查生成的文件。
|
|
165
167
|
|
|
166
|
-
具体文件取决于 `.truthmark/config.yml
|
|
167
|
-
|
|
168
|
-
确切文件取决于 `.truthmark/config.yml`。
|
|
168
|
+
具体文件取决于 `.truthmark/config.yml`,但安装形态始终相同:路由、事实文档脚手架、紧凑的受管指令,以及为启用平台生成的宿主原生工作流接口。
|
|
169
169
|
|
|
170
170
|
## 第一次真实使用
|
|
171
171
|
|
|
@@ -179,6 +179,14 @@ truthmark check
|
|
|
179
179
|
/truthmark-structure 将宽泛的 repository 区域拆成 auth、billing 和 notifications
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
+
如果项目已经有实现好的功能,但事实文档缺失或很弱,请让已安装的 Truth Document 工作流记录一个聚焦范围:
|
|
183
|
+
|
|
184
|
+
```text
|
|
185
|
+
/truthmark-document 记录 src/billing/retry.ts 及相关测试中已实现的 payment retry 行为
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Truth Document 是既有项目最常用的第一个工作流。它会检查实现、测试、路由和现有文档,然后创建或修复事实文档与路由,不会修改功能代码。
|
|
189
|
+
|
|
182
190
|
之后就正常使用你的 AI 编码代理。
|
|
183
191
|
|
|
184
192
|
当代理修改功能代码时,Truth Sync 会作为收尾保护,在交接前检查已映射的事实文档是否需要改变。
|
|
@@ -188,21 +196,21 @@ truthmark check
|
|
|
188
196
|
| 能力 | 作用 |
|
|
189
197
|
| --- | --- |
|
|
190
198
|
| Git 原生事实 | 将仓库事实保存在已提交的 Markdown 和配置中。 |
|
|
191
|
-
|
|
|
199
|
+
| 按分支生效的文档 | 事实随分支移动,而不是存在于私有会话中。 |
|
|
192
200
|
| 面向人的 CLI | 为维护者提供设置、刷新、验证和检查命令。 |
|
|
193
201
|
| 面向 AI 的工作流 | 为代理提供宿主原生的同步、文档、结构、预览、实现和审计工作流。 |
|
|
194
202
|
| 显式路由 | 将代码区域映射到规范事实文档。 |
|
|
195
203
|
| 可审查交接 | 为代码和事实文档都产生普通 Git diff。 |
|
|
196
204
|
| 本地优先运行 | 不需要托管服务、守护进程、数据库或 MCP 服务器。 |
|
|
197
205
|
| 更安全的写入边界 | 区分 code-first、doc-first、read-only 和 doc-only 工作流。 |
|
|
198
|
-
| 验证 | 报告路由、权限边界、frontmatter
|
|
206
|
+
| 验证 | 报告路由、权限边界、frontmatter、链接、生成接口、分支范围、freshness 和覆盖率问题。 |
|
|
199
207
|
| 可选 Portal | 在明确启用并请求时,从 Markdown 事实文档生成已提交的静态 HTML 展示站点。 |
|
|
200
208
|
|
|
201
209
|
## 视觉概览
|
|
202
210
|
|
|
203
211
|

|
|
204
212
|
|
|
205
|
-
**功能:** Truthmark
|
|
213
|
+
**功能:** Truthmark 会安装什么,以及工作流接口如何拆分。
|
|
206
214
|
|
|
207
215
|

|
|
208
216
|
|
|
@@ -220,7 +228,7 @@ Truthmark 面向已经知道 AI 代理能生成代码的团队。
|
|
|
220
228
|
|
|
221
229
|
不是仪式化治理。治理就是一个简单问题:
|
|
222
230
|
|
|
223
|
-
> 这次 AI
|
|
231
|
+
> 这次 AI 辅助变更之后,仓库仍然准确反映事实吗?
|
|
224
232
|
|
|
225
233
|
Truthmark 通过已提交文件、显式路由和可审查 diff 帮助团队回答这个问题。
|
|
226
234
|
|
|
@@ -229,10 +237,10 @@ Truthmark 通过已提交文件、显式路由和可审查 diff 帮助团队回
|
|
|
229
237
|
- 更少的文档漂移
|
|
230
238
|
- 更好的交接
|
|
231
239
|
- 按分支生效的产品事实
|
|
232
|
-
- 持久的架构和 API
|
|
240
|
+
- 持久的架构和 API 文档
|
|
233
241
|
- 文档与代码之间的明确所有权
|
|
234
242
|
- 更安全的代理写入边界
|
|
235
|
-
-
|
|
243
|
+
- 可审查文档,而不是隐藏记忆层
|
|
236
244
|
- 仍然能从已提交 repo 文件运行的 AI 工作流
|
|
237
245
|
|
|
238
246
|
## Truthmark 适合放在哪里
|
|
@@ -248,7 +256,7 @@ Truthmark 不替代提示词、记忆、规格、测试或代码审查。
|
|
|
248
256
|
| plan-first 的功能工作 | 规格工作流 |
|
|
249
257
|
| 随代码移动、按分支生效的事实 | Truthmark |
|
|
250
258
|
| 验证行为正确性 | 测试和审查 |
|
|
251
|
-
| 审查 AI
|
|
259
|
+
| 审查 AI 辅助的文档变更 | Truthmark 加 Git 审查 |
|
|
252
260
|
|
|
253
261
|
Truthmark 的范围故意很窄:
|
|
254
262
|
|
|
@@ -265,7 +273,7 @@ Truthmark 在本地针对当前 Git worktree 运行。
|
|
|
265
273
|
|
|
266
274
|
面向人的 CLI 读取并写入仓库文件,然后退出。
|
|
267
275
|
|
|
268
|
-
面向 AI
|
|
276
|
+
面向 AI 的工作流接口是已提交文件,代理宿主之后可以加载它们。这意味着代理可以从仓库状态遵循已安装工作流,而不依赖后台 Truthmark 进程。
|
|
269
277
|
|
|
270
278
|
这些层的关系如下:
|
|
271
279
|
|
|
@@ -283,9 +291,9 @@ flowchart LR
|
|
|
283
291
|
|
|
284
292
|
Agent 不会连接 Truthmark daemon,但工作流需要验证、索引或 helper checks 时,它们可以运行已安装的 Truthmark CLI。
|
|
285
293
|
|
|
286
|
-
Truthmark
|
|
294
|
+
Truthmark 拥有它生成的工作流接口,但关键契约是架构层面的:仓库内配置和路由把 agent 指向规范 truth 文档,host-native 工作流则让每个受支持的 agent 用自己的方式运行同一套 Truthmark 流程。
|
|
287
295
|
|
|
288
|
-
|
|
296
|
+
生成的工作流接口包含 Truthmark 版本标记。升级 Truthmark 后,重新运行:
|
|
289
297
|
|
|
290
298
|
```bash
|
|
291
299
|
truthmark init
|
|
@@ -303,7 +311,7 @@ truthmark init
|
|
|
303
311
|
truthmark init
|
|
304
312
|
```
|
|
305
313
|
|
|
306
|
-
| 平台配置名 |
|
|
314
|
+
| 平台配置名 | 生成接口 | 调用形式 |
|
|
307
315
|
| --- | --- | --- |
|
|
308
316
|
| `codex` | Skill packages 和 verifier agents | `/truthmark-*` 或 `$truthmark-*` |
|
|
309
317
|
| `claude-code` | Project skills、verifier agents 和受管说明 | `/truthmark-*` |
|
|
@@ -333,14 +341,14 @@ truthmark init
|
|
|
333
341
|
|
|
334
342
|
### 重要区别
|
|
335
343
|
|
|
336
|
-
|
|
344
|
+
不要混淆这两个接口:
|
|
337
345
|
|
|
338
|
-
|
|
|
346
|
+
| 接口 | 使用者 | 示例 | 含义 |
|
|
339
347
|
| --- | --- | --- | --- |
|
|
340
348
|
| 面向人的 CLI | 人类、脚本、类似 CI 的检查 | `truthmark check` | 从终端验证仓库事实产物。 |
|
|
341
349
|
| 面向 AI 的工作流 | 编码代理和代理宿主 | `/truthmark-check` | 请求代理运行已安装的审计工作流。 |
|
|
342
350
|
|
|
343
|
-
|
|
351
|
+
名称有意相关,但接口不同。
|
|
344
352
|
|
|
345
353
|
## 普通 AI 辅助代码变更
|
|
346
354
|
|
|
@@ -354,7 +362,7 @@ Truth Sync 是为功能代码变更安装的收尾保护。
|
|
|
354
362
|
已安装工作流检测到功能代码变更
|
|
355
363
|
Truth Sync 检查已映射事实文档
|
|
356
364
|
代理在需要时更新事实文档
|
|
357
|
-
人类审查代码 diff +
|
|
365
|
+
人类审查代码 diff + 事实文档 diff
|
|
358
366
|
```
|
|
359
367
|
|
|
360
368
|
直接调用仍然适用于排查问题、强制提前同步,或让交接更明确:
|
|
@@ -365,12 +373,16 @@ Truth Sync 检查已映射事实文档
|
|
|
365
373
|
|
|
366
374
|
## 已有行为但没有文档
|
|
367
375
|
|
|
368
|
-
|
|
376
|
+
当实现已经存在但仓库事实不完整时,使用 Truth Document。对于代码库已经存在后才接入 Truthmark 的成熟仓库,这是常规路径。
|
|
369
377
|
|
|
370
378
|
```text
|
|
371
|
-
/truthmark-document
|
|
379
|
+
/truthmark-document 记录 src/auth/session.ts、src/auth/middleware.ts 和 tests/auth/session.test.ts 中已实现的 session timeout 行为
|
|
372
380
|
```
|
|
373
381
|
|
|
382
|
+
提供功能名、代码路径、测试路径或目标事实文档区域。在 OpenCode 风格的宿主中,同一个工作流用 `/skill truthmark-document ...` 调用;在 Gemini CLI 中,使用 `/truthmark:doc ...`。
|
|
383
|
+
|
|
384
|
+
如果大型仓库仍然只有一个宽泛的占位路由,请先运行 Truth Structure,然后每次针对一个有边界的功能或区域调用 Truth Document。
|
|
385
|
+
|
|
374
386
|
Truth Document 会把实现、测试、路由文件和现有文档作为证据来检查。
|
|
375
387
|
|
|
376
388
|
它只写事实文档和路由。
|
|
@@ -382,7 +394,7 @@ Truth Document 会把实现、测试、路由文件和现有文档作为证据
|
|
|
382
394
|
当产品或架构决策从文档开始,并且代码应更新以匹配时,使用 Truth Realize。
|
|
383
395
|
|
|
384
396
|
```text
|
|
385
|
-
/truthmark-realize 将 docs/truth/authentication/session-timeout.md 实现到代码中
|
|
397
|
+
/truthmark-realize 将 docs/truthmark/truth/authentication/session-timeout.md 实现到代码中
|
|
386
398
|
```
|
|
387
399
|
|
|
388
400
|
Truth Realize 是 doc-first。
|
|
@@ -426,10 +438,10 @@ truthmark check
|
|
|
426
438
|
| 命令 | 用途 |
|
|
427
439
|
| --- | --- |
|
|
428
440
|
| `truthmark config` | 创建 `.truthmark/config.yml`。除非使用 `--stdout`,否则只写这个文件。 |
|
|
429
|
-
| `truthmark init` |
|
|
430
|
-
| `truthmark check` | 验证配置、权限边界、路由、承载决策的文档、frontmatter
|
|
441
|
+
| `truthmark init` | 从已审查配置安装或刷新已配置的工作流接口。 |
|
|
442
|
+
| `truthmark check` | 验证配置、权限边界、路由、承载决策的文档、frontmatter、内部链接、分支范围、生成接口、freshness 和覆盖率诊断。 |
|
|
431
443
|
|
|
432
|
-
可选的仓库情报辅助工具会为当前 checkout
|
|
444
|
+
可选的仓库情报辅助工具会为当前 checkout 生成派生审查材料,例如 RepoIndex、RouteMap、ImpactSet 和有边界的 ContextPack 产物。生成的工作流 skill packages 也可以暴露 helper manifests 和 helper policies,用来调用已安装的 `truthmark validate ... --json` CLI validators;这些 helpers 是加速器,不是打包进仓库的本地脚本,也不是事实来源。独立的 Copilot prompts 和 Gemini commands 在已安装 runner 可用时使用同一 CLI validator contract;不可用时应报告可见的 skipped helper status,并进行 manual validation。
|
|
433
445
|
|
|
434
446
|
它们不是事实来源。
|
|
435
447
|
|
|
@@ -437,7 +449,7 @@ truthmark check
|
|
|
437
449
|
| --- | --- |
|
|
438
450
|
| `truthmark index` | 为当前 checkout 构建 RepoIndex 和 RouteMap JSON。 |
|
|
439
451
|
| `truthmark impact --base <ref>` | 将变更文件映射到已路由事实文档、所属路由、附近测试和公开符号。 |
|
|
440
|
-
| `truthmark
|
|
452
|
+
| `truthmark ctx --workflow <workflow> [--base <ref>]` | 为 Truth Sync、Truth Document 或 Truth Realize 生成有边界的 ContextPack。使用 `--format markdown` 生成可读版本。 |
|
|
441
453
|
|
|
442
454
|
受支持位置可使用 `--json` 获取结构化输出。
|
|
443
455
|
|
|
@@ -456,10 +468,10 @@ Truthmark Portal 是一个可选的展示工作流,适合想要基于已提交
|
|
|
456
468
|
用这个命名空间配置块启用它:
|
|
457
469
|
|
|
458
470
|
```yaml
|
|
459
|
-
truthmark
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
471
|
+
truthmark:
|
|
472
|
+
generated:
|
|
473
|
+
portal:
|
|
474
|
+
enabled: true
|
|
463
475
|
```
|
|
464
476
|
|
|
465
477
|
然后重新运行:
|
|
@@ -468,7 +480,7 @@ truthmark-portal:
|
|
|
468
480
|
truthmark init
|
|
469
481
|
```
|
|
470
482
|
|
|
471
|
-
启用后,Truthmark 会为已配置平台安装宿主原生 Portal
|
|
483
|
+
启用后,Truthmark 会为已配置平台安装宿主原生 Portal 工作流接口,例如 `/truthmark-portal` 或 `/truthmark:portal`,具体取决于代理宿主。
|
|
472
484
|
|
|
473
485
|
## 配置
|
|
474
486
|
|
|
@@ -497,34 +509,34 @@ truthmark init
|
|
|
497
509
|
| 配置区域 | 用途 |
|
|
498
510
|
| --- | --- |
|
|
499
511
|
| `version` | 配置契约版本。 |
|
|
500
|
-
| `platforms` |
|
|
501
|
-
| `
|
|
502
|
-
| `
|
|
503
|
-
| `
|
|
504
|
-
| `
|
|
505
|
-
| `
|
|
506
|
-
| `
|
|
507
|
-
| `truthmark
|
|
508
|
-
| `
|
|
509
|
-
| `instruction_targets` |
|
|
512
|
+
| `platforms` | 应接收平台专属生成接口的代理宿主。 |
|
|
513
|
+
| `truthmark.workspace` | Truthmark 拥有的工作区,用于路由、事实文档、模板和生成的展示输出。 |
|
|
514
|
+
| `truthmark.routes.index` | 相对于 `truthmark.workspace` 的根路由索引路径。 |
|
|
515
|
+
| `truthmark.routes.areas` | 相对于 `truthmark.workspace` 的委托子路由目录。 |
|
|
516
|
+
| `truthmark.routes.default_area` | 初始脚手架子路由 basename。 |
|
|
517
|
+
| `truthmark.routes.max_delegation_depth` | 当前最大路由委托深度。 |
|
|
518
|
+
| `truthmark.truth.root` | 相对于 `truthmark.workspace` 的事实文档根。 |
|
|
519
|
+
| `truthmark.templates.root` | 相对于 `truthmark.workspace` 的事实文档模板根。 |
|
|
520
|
+
| `truthmark.generated.portal` | 可选手动展示工作流启用设置:`enabled`。 |
|
|
521
|
+
| `instruction_targets` | 接收共享受管指令块的文件,例如 `AGENTS.md`。 |
|
|
510
522
|
| `frontmatter.required` | 缺失时产生错误诊断的元数据字段。 |
|
|
511
523
|
| `frontmatter.recommended` | 缺失时产生审查诊断的元数据字段。 |
|
|
512
524
|
| `ignore` | 从相关检查和路由逻辑中排除的 glob 模式。 |
|
|
513
525
|
|
|
514
526
|
## 仓库事实路由
|
|
515
527
|
|
|
516
|
-
Truthmark
|
|
528
|
+
Truthmark 将代码区域映射到事实文档。
|
|
517
529
|
|
|
518
530
|
主要路由文件是:
|
|
519
531
|
|
|
520
532
|
```text
|
|
521
|
-
docs/truthmark/areas.md
|
|
522
|
-
docs/truthmark/areas/**/*.md
|
|
533
|
+
docs/truthmark/routes/areas.md
|
|
534
|
+
docs/truthmark/routes/areas/**/*.md
|
|
523
535
|
```
|
|
524
536
|
|
|
525
537
|
路由告诉代理:
|
|
526
538
|
|
|
527
|
-
-
|
|
539
|
+
- 哪个代码区域属于某个区域
|
|
528
540
|
- 哪些事实文档拥有该区域
|
|
529
541
|
- 何时应该更新事实
|
|
530
542
|
- 涉及哪类事实文档
|
|
@@ -548,13 +560,13 @@ Truthmark 安装一个紧凑、仓库原生的事实层。
|
|
|
548
560
|
它分为四层安装:
|
|
549
561
|
|
|
550
562
|
- 用于所有权边界的配置和路由
|
|
551
|
-
-
|
|
552
|
-
-
|
|
553
|
-
-
|
|
563
|
+
- 规范事实文档和起始模板
|
|
564
|
+
- 用于仓库级代理指令的紧凑受管指令块
|
|
565
|
+
- 为配置中启用的平台生成宿主原生的工作流包、命令、prompts 和 verifier agents
|
|
554
566
|
|
|
555
|
-
Truthmark
|
|
567
|
+
Truthmark 会保留受管指令块之外的手写内容。
|
|
556
568
|
|
|
557
|
-
|
|
569
|
+
生成的工作流接口由 Truthmark 管理,可以通过重新运行来刷新:
|
|
558
570
|
|
|
559
571
|
```bash
|
|
560
572
|
truthmark init
|
|
@@ -633,7 +645,7 @@ truthmark check
|
|
|
633
645
|
### 记录已实现行为
|
|
634
646
|
|
|
635
647
|
```text
|
|
636
|
-
/truthmark-document 在 docs/truth/authentication 下记录已实现的密码重置流程
|
|
648
|
+
/truthmark-document 在 docs/truthmark/truth/authentication 下记录已实现的密码重置流程
|
|
637
649
|
```
|
|
638
650
|
|
|
639
651
|
### 代码变更后同步
|
|
@@ -645,7 +657,7 @@ truthmark check
|
|
|
645
657
|
### 实现 doc-first 决策
|
|
646
658
|
|
|
647
659
|
```text
|
|
648
|
-
/truthmark-realize 将 docs/truth/billing/invoice-retry-policy.md 实现到代码中
|
|
660
|
+
/truthmark-realize 将 docs/truthmark/truth/billing/invoice-retry-policy.md 实现到代码中
|
|
649
661
|
```
|
|
650
662
|
|
|
651
663
|
### 从终端审计事实健康
|
|
@@ -654,25 +666,25 @@ truthmark check
|
|
|
654
666
|
truthmark check
|
|
655
667
|
```
|
|
656
668
|
|
|
657
|
-
###
|
|
669
|
+
### 生成分支影响摘要
|
|
658
670
|
|
|
659
671
|
```bash
|
|
660
672
|
truthmark impact --base main
|
|
661
673
|
```
|
|
662
674
|
|
|
663
|
-
###
|
|
675
|
+
### 生成工作流 ContextPack
|
|
664
676
|
|
|
665
677
|
```bash
|
|
666
|
-
truthmark
|
|
678
|
+
truthmark ctx --workflow truth-sync --base main --format markdown
|
|
667
679
|
```
|
|
668
680
|
|
|
669
681
|
### 启用可选 Portal 工作流
|
|
670
682
|
|
|
671
683
|
```yaml
|
|
672
|
-
truthmark
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
684
|
+
truthmark:
|
|
685
|
+
generated:
|
|
686
|
+
portal:
|
|
687
|
+
enabled: true
|
|
676
688
|
```
|
|
677
689
|
|
|
678
690
|
```bash
|
|
@@ -690,19 +702,19 @@ Truthmark V1 目前提供:
|
|
|
690
702
|
- `truthmark check`
|
|
691
703
|
- `truthmark index`
|
|
692
704
|
- `truthmark impact`
|
|
693
|
-
- `truthmark
|
|
705
|
+
- `truthmark ctx`
|
|
694
706
|
- 分支范围元数据
|
|
695
|
-
-
|
|
696
|
-
- 生成的 Truth Structure
|
|
697
|
-
- 生成的 Truth Document
|
|
698
|
-
- 生成的 Truth Sync
|
|
699
|
-
- 生成的 Truth Preview
|
|
700
|
-
- 生成的 Truth Realize
|
|
701
|
-
- 生成的 Truth Check
|
|
702
|
-
- 可选生成的 Truthmark Portal
|
|
703
|
-
- 路由、权限边界、决策结构、frontmatter、链接、freshness
|
|
707
|
+
- 受管指令块
|
|
708
|
+
- 生成的 Truth Structure 工作流接口
|
|
709
|
+
- 生成的 Truth Document 工作流接口
|
|
710
|
+
- 生成的 Truth Sync 工作流接口
|
|
711
|
+
- 生成的 Truth Preview 工作流接口
|
|
712
|
+
- 生成的 Truth Realize 工作流接口
|
|
713
|
+
- 生成的 Truth Check 工作流接口
|
|
714
|
+
- 可选生成的 Truthmark Portal 工作流接口
|
|
715
|
+
- 路由、权限边界、决策结构、frontmatter、链接、freshness、生成接口和覆盖率诊断
|
|
704
716
|
- 派生的 RepoIndex、RouteMap、ImpactSet 和 ContextPack 产物
|
|
705
|
-
- 面向 Codex、Claude Code、GitHub Copilot、OpenCode 和 Gemini CLI
|
|
717
|
+
- 面向 Codex、Claude Code、GitHub Copilot、OpenCode 和 Gemini CLI 的宿主专属接口
|
|
706
718
|
|
|
707
719
|
## 开发
|
|
708
720
|
|
|
@@ -746,11 +758,11 @@ README 是评估和设置的快速路径。
|
|
|
746
758
|
详细的当前行为位于 `docs/` 下:
|
|
747
759
|
|
|
748
760
|
- [文档索引](docs/README.md)
|
|
749
|
-
- [架构概览](docs/architecture/overview.md)
|
|
750
|
-
- [API 和 CLI 契约](docs/truth/contracts.md)
|
|
751
|
-
- [Init 和脚手架行为](docs/truth/init-and-scaffold.md)
|
|
752
|
-
- [Check 诊断](docs/truth/check-diagnostics.md)
|
|
753
|
-
- [已安装工作流](docs/truth/workflows/overview.md)
|
|
761
|
+
- [架构概览](docs/truthmark/truth/architecture/overview.md)
|
|
762
|
+
- [API 和 CLI 契约](docs/truthmark/truth/contracts.md)
|
|
763
|
+
- [Init 和脚手架行为](docs/truthmark/truth/init-and-scaffold.md)
|
|
764
|
+
- [Check 诊断](docs/truthmark/truth/check-diagnostics.md)
|
|
765
|
+
- [已安装工作流](docs/truthmark/truth/workflows/overview.md)
|
|
754
766
|
- [仓库事实维护指南](docs/standards/maintaining-repository-truth.md)
|
|
755
767
|
|
|
756
768
|
## 设计边界
|
|
@@ -784,10 +796,10 @@ Truthmark 帮助仓库保持诚实。它不能证明代码正确。
|
|
|
784
796
|
- 审查事实文档变更
|
|
785
797
|
- 不把 secrets 放进文档
|
|
786
798
|
- 把仓库专属说明保留在受管块之外
|
|
787
|
-
-
|
|
799
|
+
- 升级后审查生成工作流接口的 diff
|
|
788
800
|
- 保留人类对产品和架构决策的所有权
|
|
789
801
|
|
|
790
|
-
Truthmark
|
|
802
|
+
Truthmark 让面向代理的仓库事实可见。它不替代人类判断。
|
|
791
803
|
|
|
792
804
|
## 路线图方向
|
|
793
805
|
|
|
@@ -797,8 +809,8 @@ Truthmark 让代理上下文可见。它不替代人类判断。
|
|
|
797
809
|
- 更清晰的采用示例
|
|
798
810
|
- 展示真实 Truth Sync 循环的示例仓库
|
|
799
811
|
- 面向已经使用代理说明文件团队的迁移指南
|
|
800
|
-
-
|
|
801
|
-
-
|
|
812
|
+
- 生成宿主接口的符合性测试
|
|
813
|
+
- 基于路由的 stale truth 提示
|
|
802
814
|
- 面向 doc-first 工作的有边界实现清单
|
|
803
815
|
|
|
804
816
|
重心保持不变:
|
|
@@ -807,7 +819,7 @@ Truthmark 让代理上下文可见。它不替代人类判断。
|
|
|
807
819
|
仓库事实
|
|
808
820
|
代理原生工作流
|
|
809
821
|
Git 审查
|
|
810
|
-
|
|
822
|
+
按分支生效的文档
|
|
811
823
|
```
|
|
812
824
|
|
|
813
825
|
## 许可证
|