truthmark 1.6.1 → 2.2.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.zh.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # Truthmark
2
2
 
3
- **你的代理会写代码。Truthmark 让它们的上下文在 Git 中可审查。**
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
  ![Truthmark 横幅](docs/assets/truthmark-banner.png)
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,却看不到相关的事实 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 + 事实 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 会安装宿主原生的技能、提示、命令、受管说明块和受支持的子代理表面,让 AI 代理能在正常编码工具中遵循仓库专属的事实工作流。
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,8 @@ truthmark init
152
152
 
153
153
  - 路由文件
154
154
  - 事实文档脚手架
155
- - 受管说明块
156
- - 已配置平台的面向 AI 工作流表面
155
+ - 受管指令块
156
+ - 已配置平台的面向 AI 工作流接口
157
157
 
158
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 等公认软件工程参考。
159
159
 
@@ -165,9 +165,7 @@ truthmark check
165
165
 
166
166
  然后在提交前审查生成的文件。
167
167
 
168
- 具体文件取决于 `.truthmark/config.yml`,但安装形态始终相同:路由、truth scaffolding、紧凑的受管说明,以及为启用平台生成的 host-native 工作流表面。
169
-
170
- 确切文件取决于 `.truthmark/config.yml`。
168
+ 具体文件取决于 `.truthmark/config.yml`,但安装形态始终相同:路由、事实文档脚手架、紧凑的受管指令,以及为启用平台生成的宿主原生工作流接口。
171
169
 
172
170
  ## 第一次真实使用
173
171
 
@@ -181,6 +179,14 @@ truthmark check
181
179
  /truthmark-structure 将宽泛的 repository 区域拆成 auth、billing 和 notifications
182
180
  ```
183
181
 
182
+ 如果项目已经有实现好的功能,但事实文档缺失或很弱,请让已安装的 Truth Document 工作流记录一个聚焦范围:
183
+
184
+ ```text
185
+ /truthmark-document 记录 src/billing/retry.ts 及相关测试中已实现的 payment retry 行为
186
+ ```
187
+
188
+ Truth Document 是既有项目最常用的第一个工作流。它会检查实现、测试、路由和现有文档,然后创建或修复事实文档与路由,不会修改功能代码。
189
+
184
190
  之后就正常使用你的 AI 编码代理。
185
191
 
186
192
  当代理修改功能代码时,Truth Sync 会作为收尾保护,在交接前检查已映射的事实文档是否需要改变。
@@ -190,21 +196,21 @@ truthmark check
190
196
  | 能力 | 作用 |
191
197
  | --- | --- |
192
198
  | Git 原生事实 | 将仓库事实保存在已提交的 Markdown 和配置中。 |
193
- | 按分支生效的上下文 | 事实随分支移动,而不是存在于私有会话中。 |
199
+ | 按分支生效的文档 | 事实随分支移动,而不是存在于私有会话中。 |
194
200
  | 面向人的 CLI | 为维护者提供设置、刷新、验证和检查命令。 |
195
201
  | 面向 AI 的工作流 | 为代理提供宿主原生的同步、文档、结构、预览、实现和审计工作流。 |
196
202
  | 显式路由 | 将代码区域映射到规范事实文档。 |
197
203
  | 可审查交接 | 为代码和事实文档都产生普通 Git diff。 |
198
204
  | 本地优先运行 | 不需要托管服务、守护进程、数据库或 MCP 服务器。 |
199
205
  | 更安全的写入边界 | 区分 code-first、doc-first、read-only 和 doc-only 工作流。 |
200
- | 验证 | 报告路由、权限边界、frontmatter、链接、生成表面、分支范围、freshness 和覆盖率问题。 |
206
+ | 验证 | 报告路由、权限边界、frontmatter、链接、生成接口、分支范围、freshness 和覆盖率问题。 |
201
207
  | 可选 Portal | 在明确启用并请求时,从 Markdown 事实文档生成已提交的静态 HTML 展示站点。 |
202
208
 
203
209
  ## 视觉概览
204
210
 
205
211
  ![Truthmark 功能](docs/assets/truthmark-features.png)
206
212
 
207
- **功能:** Truthmark 会安装什么,以及工作流表面如何拆分。
213
+ **功能:** Truthmark 会安装什么,以及工作流接口如何拆分。
208
214
 
209
215
  ![Truthmark 定位](docs/assets/truthmark-position.png)
210
216
 
@@ -222,7 +228,7 @@ Truthmark 面向已经知道 AI 代理能生成代码的团队。
222
228
 
223
229
  不是仪式化治理。治理就是一个简单问题:
224
230
 
225
- > 这次 AI 辅助变更之后,仓库还在讲真话吗?
231
+ > 这次 AI 辅助变更之后,仓库仍然准确反映事实吗?
226
232
 
227
233
  Truthmark 通过已提交文件、显式路由和可审查 diff 帮助团队回答这个问题。
228
234
 
@@ -231,10 +237,10 @@ Truthmark 通过已提交文件、显式路由和可审查 diff 帮助团队回
231
237
  - 更少的文档漂移
232
238
  - 更好的交接
233
239
  - 按分支生效的产品事实
234
- - 持久的架构和 API 上下文
240
+ - 持久的架构和 API 文档
235
241
  - 文档与代码之间的明确所有权
236
242
  - 更安全的代理写入边界
237
- - 可审查上下文,而不是隐藏记忆
243
+ - 可审查文档,而不是隐藏记忆层
238
244
  - 仍然能从已提交 repo 文件运行的 AI 工作流
239
245
 
240
246
  ## Truthmark 适合放在哪里
@@ -250,7 +256,7 @@ Truthmark 不替代提示词、记忆、规格、测试或代码审查。
250
256
  | plan-first 的功能工作 | 规格工作流 |
251
257
  | 随代码移动、按分支生效的事实 | Truthmark |
252
258
  | 验证行为正确性 | 测试和审查 |
253
- | 审查 AI 辅助的上下文变更 | Truthmark 加 Git 审查 |
259
+ | 审查 AI 辅助的文档变更 | Truthmark 加 Git 审查 |
254
260
 
255
261
  Truthmark 的范围故意很窄:
256
262
 
@@ -267,7 +273,7 @@ Truthmark 在本地针对当前 Git worktree 运行。
267
273
 
268
274
  面向人的 CLI 读取并写入仓库文件,然后退出。
269
275
 
270
- 面向 AI 的工作流表面是已提交文件,代理宿主之后可以加载它们。这意味着代理可以从仓库状态遵循已安装工作流,而不依赖后台 Truthmark 进程。
276
+ 面向 AI 的工作流接口是已提交文件,代理宿主之后可以加载它们。这意味着代理可以从仓库状态遵循已安装工作流,而不依赖后台 Truthmark 进程。
271
277
 
272
278
  这些层的关系如下:
273
279
 
@@ -285,9 +291,9 @@ flowchart LR
285
291
 
286
292
  Agent 不会连接 Truthmark daemon,但工作流需要验证、索引或 helper checks 时,它们可以运行已安装的 Truthmark CLI。
287
293
 
288
- Truthmark 拥有它生成的工作流表面,但关键契约是架构层面的:仓库内配置和路由把 agent 指向规范 truth 文档,host-native 工作流则让每个受支持的 agent 用自己的方式运行同一套 Truthmark 流程。
294
+ Truthmark 拥有它生成的工作流接口,但关键契约是架构层面的:仓库内配置和路由把 agent 指向规范 truth 文档,host-native 工作流则让每个受支持的 agent 用自己的方式运行同一套 Truthmark 流程。
289
295
 
290
- 生成的工作流表面包含 Truthmark 版本标记。升级 Truthmark 后,重新运行:
296
+ 生成的工作流接口包含 Truthmark 版本标记。升级 Truthmark 后,重新运行:
291
297
 
292
298
  ```bash
293
299
  truthmark init
@@ -305,7 +311,7 @@ truthmark init
305
311
  truthmark init
306
312
  ```
307
313
 
308
- | 平台配置名 | 生成表面 | 调用形式 |
314
+ | 平台配置名 | 生成接口 | 调用形式 |
309
315
  | --- | --- | --- |
310
316
  | `codex` | Skill packages 和 verifier agents | `/truthmark-*` 或 `$truthmark-*` |
311
317
  | `claude-code` | Project skills、verifier agents 和受管说明 | `/truthmark-*` |
@@ -335,14 +341,14 @@ truthmark init
335
341
 
336
342
  ### 重要区别
337
343
 
338
- 不要混淆这两个表面:
344
+ 不要混淆这两个接口:
339
345
 
340
- | 表面 | 使用者 | 示例 | 含义 |
346
+ | 接口 | 使用者 | 示例 | 含义 |
341
347
  | --- | --- | --- | --- |
342
348
  | 面向人的 CLI | 人类、脚本、类似 CI 的检查 | `truthmark check` | 从终端验证仓库事实产物。 |
343
349
  | 面向 AI 的工作流 | 编码代理和代理宿主 | `/truthmark-check` | 请求代理运行已安装的审计工作流。 |
344
350
 
345
- 名称有意相关,但表面不同。
351
+ 名称有意相关,但接口不同。
346
352
 
347
353
  ## 普通 AI 辅助代码变更
348
354
 
@@ -356,7 +362,7 @@ Truth Sync 是为功能代码变更安装的收尾保护。
356
362
  已安装工作流检测到功能代码变更
357
363
  Truth Sync 检查已映射事实文档
358
364
  代理在需要时更新事实文档
359
- 人类审查代码 diff + 事实 diff
365
+ 人类审查代码 diff + 事实文档 diff
360
366
  ```
361
367
 
362
368
  直接调用仍然适用于排查问题、强制提前同步,或让交接更明确:
@@ -367,12 +373,16 @@ Truth Sync 检查已映射事实文档
367
373
 
368
374
  ## 已有行为但没有文档
369
375
 
370
- 当实现已经存在,但仓库事实不完整时,使用 Truth Document
376
+ 当实现已经存在但仓库事实不完整时,使用 Truth Document。对于代码库已经存在后才接入 Truthmark 的成熟仓库,这是常规路径。
371
377
 
372
378
  ```text
373
- /truthmark-document docs/truth/authentication 下记录已实现的会话超时行为
379
+ /truthmark-document 记录 src/auth/session.ts、src/auth/middleware.ts 和 tests/auth/session.test.ts 中已实现的 session timeout 行为
374
380
  ```
375
381
 
382
+ 提供功能名、代码路径、测试路径或目标事实文档区域。在 OpenCode 风格的宿主中,同一个工作流用 `/skill truthmark-document ...` 调用;在 Gemini CLI 中,使用 `/truthmark:doc ...`。
383
+
384
+ 如果大型仓库仍然只有一个宽泛的占位路由,请先运行 Truth Structure,然后每次针对一个有边界的功能或区域调用 Truth Document。
385
+
376
386
  Truth Document 会把实现、测试、路由文件和现有文档作为证据来检查。
377
387
 
378
388
  它只写事实文档和路由。
@@ -384,7 +394,7 @@ Truth Document 会把实现、测试、路由文件和现有文档作为证据
384
394
  当产品或架构决策从文档开始,并且代码应更新以匹配时,使用 Truth Realize。
385
395
 
386
396
  ```text
387
- /truthmark-realize 将 docs/truth/authentication/session-timeout.md 实现到代码中
397
+ /truthmark-realize 将 docs/truthmark/truth/authentication/session-timeout.md 实现到代码中
388
398
  ```
389
399
 
390
400
  Truth Realize 是 doc-first。
@@ -428,10 +438,10 @@ truthmark check
428
438
  | 命令 | 用途 |
429
439
  | --- | --- |
430
440
  | `truthmark config` | 创建 `.truthmark/config.yml`。除非使用 `--stdout`,否则只写这个文件。 |
431
- | `truthmark init` | 从已审查配置安装或刷新已配置的工作流表面。 |
432
- | `truthmark check` | 验证配置、权限边界、路由、承载决策的文档、frontmatter、内部链接、分支范围、生成表面、freshness 和覆盖率诊断。 |
441
+ | `truthmark init` | 从已审查配置安装或刷新已配置的工作流接口。 |
442
+ | `truthmark check` | 验证配置、权限边界、路由、承载决策的文档、frontmatter、内部链接、分支范围、生成接口、freshness 和覆盖率诊断。 |
433
443
 
434
- 可选的仓库情报辅助工具会为当前 checkout 生成派生审查上下文。生成的工作流 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。
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。
435
445
 
436
446
  它们不是事实来源。
437
447
 
@@ -439,7 +449,7 @@ truthmark check
439
449
  | --- | --- |
440
450
  | `truthmark index` | 为当前 checkout 构建 RepoIndex 和 RouteMap JSON。 |
441
451
  | `truthmark impact --base <ref>` | 将变更文件映射到已路由事实文档、所属路由、附近测试和公开符号。 |
442
- | `truthmark context --workflow <workflow> [--base <ref>]` | 为 Truth Sync、Truth Document 或 Truth Realize 生成有边界的 ContextPack。使用 `--format markdown` 生成可读版本。 |
452
+ | `truthmark ctx --workflow <workflow> [--base <ref>]` | 为 Truth Sync、Truth Document 或 Truth Realize 生成有边界的 ContextPack。使用 `--format markdown` 生成可读版本。 |
443
453
 
444
454
  受支持位置可使用 `--json` 获取结构化输出。
445
455
 
@@ -458,10 +468,10 @@ Truthmark Portal 是一个可选的展示工作流,适合想要基于已提交
458
468
  用这个命名空间配置块启用它:
459
469
 
460
470
  ```yaml
461
- truthmark-portal:
462
- enabled: true
463
- output: docs/truthmark-portal
464
- template: default
471
+ truthmark:
472
+ generated:
473
+ portal:
474
+ enabled: true
465
475
  ```
466
476
 
467
477
  然后重新运行:
@@ -470,7 +480,7 @@ truthmark-portal:
470
480
  truthmark init
471
481
  ```
472
482
 
473
- 启用后,Truthmark 会为已配置平台安装宿主原生 Portal 工作流表面,例如 `/truthmark-portal` 或 `/truthmark:portal`,具体取决于代理宿主。
483
+ 启用后,Truthmark 会为已配置平台安装宿主原生 Portal 工作流接口,例如 `/truthmark-portal` 或 `/truthmark:portal`,具体取决于代理宿主。
474
484
 
475
485
  ## 配置
476
486
 
@@ -499,34 +509,31 @@ truthmark init
499
509
  | 配置区域 | 用途 |
500
510
  | --- | --- |
501
511
  | `version` | 配置契约版本。 |
502
- | `platforms` | 应接收平台专属生成表面的代理宿主。 |
503
- | `docs.layout` | 当前文档布局模式。 |
504
- | `docs.roots` | 命名的规范文档根。 |
505
- | `docs.routing.root_index` | 根路由索引路径。 |
506
- | `docs.routing.area_files_root` | 委托子路由文件目录。 |
507
- | `docs.routing.default_area` | 初始脚手架子路由 basename。 |
508
- | `docs.routing.max_delegation_depth` | 当前最大路由委托深度。 |
509
- | `truthmark-portal` | 可选手动展示工作流设置:`enabled`、`output` 和 `template`。 |
510
- | `authority` | 用作仓库事实权威的有序规范文档和 glob。 |
511
- | `instruction_targets` | 接收共享受管说明块的文件,例如 `AGENTS.md`。 |
512
+ | `platforms` | 应接收平台专属生成接口的代理宿主。 |
513
+ | `truthmark.workspace` | Truthmark 拥有的工作区,用于路由、事实文档、模板和生成的展示输出。 |
514
+ | 固定路由 | 路由固定在 `truthmark.workspace` 内的 `routes/areas.md` 和 `routes/areas/`;默认 area 是 `repository`,委托深度为 `1`。 |
515
+ | 固定事实分区 | 产品事实位于 `truthmark.workspace` 内的 `product/`,工程事实位于 `engineering/`。 |
516
+ | 固定模板 | 事实文档模板固定在 `truthmark.workspace` 内的 `templates/`。 |
517
+ | `truthmark.generated.portal` | 可选手动展示工作流启用设置:`enabled`。 |
518
+ | `instruction_targets` | 接收共享受管指令块的文件,例如 `AGENTS.md`。 |
512
519
  | `frontmatter.required` | 缺失时产生错误诊断的元数据字段。 |
513
520
  | `frontmatter.recommended` | 缺失时产生审查诊断的元数据字段。 |
514
521
  | `ignore` | 从相关检查和路由逻辑中排除的 glob 模式。 |
515
522
 
516
523
  ## 仓库事实路由
517
524
 
518
- Truthmark 将代码表面映射到事实文档。
525
+ Truthmark 将代码区域映射到事实文档。
519
526
 
520
527
  主要路由文件是:
521
528
 
522
529
  ```text
523
- docs/truthmark/areas.md
524
- docs/truthmark/areas/**/*.md
530
+ docs/truthmark/routes/areas.md
531
+ docs/truthmark/routes/areas/**/*.md
525
532
  ```
526
533
 
527
534
  路由告诉代理:
528
535
 
529
- - 哪个代码表面属于某个区域
536
+ - 哪个代码区域属于某个区域
530
537
  - 哪些事实文档拥有该区域
531
538
  - 何时应该更新事实
532
539
  - 涉及哪类事实文档
@@ -550,13 +557,13 @@ Truthmark 安装一个紧凑、仓库原生的事实层。
550
557
  它分为四层安装:
551
558
 
552
559
  - 用于所有权边界的配置和路由
553
- - 规范 truth 文档和起始模板
554
- - 用于仓库级 agent 上下文的紧凑受管说明块
555
- - 为配置中启用的平台生成 host-native 工作流包、命令、prompts 和 verifier agents
560
+ - 规范事实文档和起始模板
561
+ - 用于仓库级代理指令的紧凑受管指令块
562
+ - 为配置中启用的平台生成宿主原生的工作流包、命令、prompts 和 verifier agents
556
563
 
557
- Truthmark 会保留受管说明块之外的手写内容。
564
+ Truthmark 会保留受管指令块之外的手写内容。
558
565
 
559
- 生成的工作流表面由 Truthmark 管理,可以通过重新运行来刷新:
566
+ 生成的工作流接口由 Truthmark 管理,可以通过重新运行来刷新:
560
567
 
561
568
  ```bash
562
569
  truthmark init
@@ -635,7 +642,7 @@ truthmark check
635
642
  ### 记录已实现行为
636
643
 
637
644
  ```text
638
- /truthmark-document 在 docs/truth/authentication 下记录已实现的密码重置流程
645
+ /truthmark-document 在 docs/truthmark/truth/authentication 下记录已实现的密码重置流程
639
646
  ```
640
647
 
641
648
  ### 代码变更后同步
@@ -647,7 +654,7 @@ truthmark check
647
654
  ### 实现 doc-first 决策
648
655
 
649
656
  ```text
650
- /truthmark-realize 将 docs/truth/billing/invoice-retry-policy.md 实现到代码中
657
+ /truthmark-realize 将 docs/truthmark/truth/billing/invoice-retry-policy.md 实现到代码中
651
658
  ```
652
659
 
653
660
  ### 从终端审计事实健康
@@ -656,25 +663,25 @@ truthmark check
656
663
  truthmark check
657
664
  ```
658
665
 
659
- ### 生成分支影响上下文
666
+ ### 生成分支影响摘要
660
667
 
661
668
  ```bash
662
669
  truthmark impact --base main
663
670
  ```
664
671
 
665
- ### 生成工作流上下文
672
+ ### 生成工作流 ContextPack
666
673
 
667
674
  ```bash
668
- truthmark context --workflow truth-sync --base main --format markdown
675
+ truthmark ctx --workflow truth-sync --base main --format markdown
669
676
  ```
670
677
 
671
678
  ### 启用可选 Portal 工作流
672
679
 
673
680
  ```yaml
674
- truthmark-portal:
675
- enabled: true
676
- output: docs/truthmark-portal
677
- template: default
681
+ truthmark:
682
+ generated:
683
+ portal:
684
+ enabled: true
678
685
  ```
679
686
 
680
687
  ```bash
@@ -692,19 +699,19 @@ Truthmark V1 目前提供:
692
699
  - `truthmark check`
693
700
  - `truthmark index`
694
701
  - `truthmark impact`
695
- - `truthmark context`
702
+ - `truthmark ctx`
696
703
  - 分支范围元数据
697
- - 受管说明块
698
- - 生成的 Truth Structure 工作流表面
699
- - 生成的 Truth Document 工作流表面
700
- - 生成的 Truth Sync 工作流表面
701
- - 生成的 Truth Preview 工作流表面
702
- - 生成的 Truth Realize 工作流表面
703
- - 生成的 Truth Check 工作流表面
704
- - 可选生成的 Truthmark Portal 工作流表面
705
- - 路由、权限边界、决策结构、frontmatter、链接、freshness、生成表面和覆盖率诊断
704
+ - 受管指令块
705
+ - 生成的 Truth Structure 工作流接口
706
+ - 生成的 Truth Document 工作流接口
707
+ - 生成的 Truth Sync 工作流接口
708
+ - 生成的 Truth Preview 工作流接口
709
+ - 生成的 Truth Realize 工作流接口
710
+ - 生成的 Truth Check 工作流接口
711
+ - 可选生成的 Truthmark Portal 工作流接口
712
+ - 路由、权限边界、决策结构、frontmatter、链接、freshness、生成接口和覆盖率诊断
706
713
  - 派生的 RepoIndex、RouteMap、ImpactSet 和 ContextPack 产物
707
- - 面向 Codex、Claude Code、GitHub Copilot、OpenCode 和 Gemini CLI 的宿主专属表面
714
+ - 面向 Codex、Claude Code、GitHub Copilot、OpenCode 和 Gemini CLI 的宿主专属接口
708
715
 
709
716
  ## 开发
710
717
 
@@ -739,7 +746,7 @@ npm run check
739
746
  | `npm run check` | 运行 lint、typecheck、测试和 build。 |
740
747
  | `npm run release:check` | 运行面向发布的验证。 |
741
748
 
742
- 修改 Truthmark 本身时,请参阅 [CONTRIBUTORS.md](CONTRIBUTORS.md)。
749
+ 修改 Truthmark 本身时,请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
743
750
 
744
751
  ## 文档
745
752
 
@@ -748,11 +755,11 @@ README 是评估和设置的快速路径。
748
755
  详细的当前行为位于 `docs/` 下:
749
756
 
750
757
  - [文档索引](docs/README.md)
751
- - [架构概览](docs/architecture/overview.md)
752
- - [API 和 CLI 契约](docs/truth/contracts.md)
753
- - [Init 和脚手架行为](docs/truth/init-and-scaffold.md)
754
- - [Check 诊断](docs/truth/check-diagnostics.md)
755
- - [已安装工作流](docs/truth/workflows/overview.md)
758
+ - [架构概览](docs/truthmark/truth/architecture/overview.md)
759
+ - [API 和 CLI 契约](docs/truthmark/truth/contracts.md)
760
+ - [Init 和脚手架行为](docs/truthmark/truth/init-and-scaffold.md)
761
+ - [Check 诊断](docs/truthmark/truth/check-diagnostics.md)
762
+ - [已安装工作流](docs/truthmark/truth/workflows/overview.md)
756
763
  - [仓库事实维护指南](docs/standards/maintaining-repository-truth.md)
757
764
 
758
765
  ## 设计边界
@@ -786,10 +793,10 @@ Truthmark 帮助仓库保持诚实。它不能证明代码正确。
786
793
  - 审查事实文档变更
787
794
  - 不把 secrets 放进文档
788
795
  - 把仓库专属说明保留在受管块之外
789
- - 升级后审查生成工作流表面的 diff
796
+ - 升级后审查生成工作流接口的 diff
790
797
  - 保留人类对产品和架构决策的所有权
791
798
 
792
- Truthmark 让代理上下文可见。它不替代人类判断。
799
+ Truthmark 让面向代理的仓库事实可见。它不替代人类判断。
793
800
 
794
801
  ## 路线图方向
795
802
 
@@ -799,8 +806,8 @@ Truthmark 让代理上下文可见。它不替代人类判断。
799
806
  - 更清晰的采用示例
800
807
  - 展示真实 Truth Sync 循环的示例仓库
801
808
  - 面向已经使用代理说明文件团队的迁移指南
802
- - 生成宿主表面的符合性测试
803
- - 感知路由的 stale truth 提示
809
+ - 生成宿主接口的符合性测试
810
+ - 基于路由的 stale truth 提示
804
811
  - 面向 doc-first 工作的有边界实现清单
805
812
 
806
813
  重心保持不变:
@@ -809,7 +816,7 @@ Truthmark 让代理上下文可见。它不替代人类判断。
809
816
  仓库事实
810
817
  代理原生工作流
811
818
  Git 审查
812
- 按分支生效的上下文
819
+ 按分支生效的文档
813
820
  ```
814
821
 
815
822
  ## 许可证