外观
附录 L:参考资料索引
本附录是读者使用引用登记的导航层。来源与章节引用的权威登记保存在共享引用表;本页不复制全部 URL、标题和核验状态,避免形成第二份引用事实源。
一条引用怎样追溯
看到正文中的 [REF-NNN] 时,按以下顺序核对:
- 定位编号。 在共享引用表中精确搜索
REF-NNN,确认对应来源、支持范围、访问日期和核验状态。 - 查看章节局部映射。 打开同章的
.references.md,检查局部键、允许陈述和不可外推范围。局部文件负责写作语境,全局编号负责跨章追溯。 - 打开原始来源。 以来源页面、论文、规范或仓库为事实依据;登记表只说明本书怎样使用它。
- 检查事实核验。 对动态产品行为、数据、版本或容易外推的陈述,查看同章
.fact-check.md和访问日期。 - 核对正文主语。 确认正文明确区分“来源指出”“本书工程模型”“教学案例”和“实际运行证据”。
链接可打开只证明目标当前可访问,不证明来源足以支持主张。来源存在、测试通过或登记了编号,也都不能单独证明章节完成。
权威层次与职责
| 工件 | 负责什么 | 不负责什么 |
|---|---|---|
| 原始来源 | 提供可归因事实、观点、规范或产品说明 | 不决定本书模型、案例和完成状态 |
| 共享引用表 | 分配 REF-NNN、保存来源定位、允许用途、访问日期和核验状态 | 不替代原文,不保证动态页面永久不变 |
章节 .references.md | 把局部键映射到全局编号,收窄该章可使用的陈述 | 不创建第二套全局编号 |
章节 .fact-check.md | 核对正文主张、来源范围、工程模型、案例和运行证据 | 不永久冻结产品能力或外部事实 |
| 正文 | 用明确主语和引用表达面向读者的有限结论 | 不扩大来源,也不把推论伪装为来源原话 |
| 本附录 | 教读者定位、核对和报告引用问题 | 不保存完整来源副本或覆盖共享引用表 |
按章节定位
章节局部引用文件位于对应正文旁,命名为 <chapter-slug>.references.md。全局登记按章节分段;查找时优先使用精确 REF-NNN,不要根据编号大小猜测主题或权威等级。
| 部分 | 章节范围 | 局部引用目录 | 主题入口 |
|---|---|---|---|
| Part 1:基础思想 | 01–04 | docs/part-01-foundations/ | Harness、Agent、仓库上下文、可靠性原则 |
| Part 2:核心组件 | 05–14 | docs/part-02-components/ | Instructions、Context、Memory、Skill、Workflow、Tool、Environment、Retrieval、Human-in-the-loop |
| Part 3:智能闭环 | 15–20 | docs/part-03-intelligence-loop/ | Observation、Reflection、Evaluation、Recovery、Compaction、自改进边界 |
| Part 4:工程实践 | 21–27 | docs/part-04-engineering-practice/ | 产品适配、仓库规则、自动化、MCP、浏览器、多 Agent、Git |
| Part 5:案例 | 28–35 | docs/part-05-case-studies/ | 最小 Harness、软件工程、应用交付、测试、Bug、项目记忆、Skill 治理、企业架构 |
| Part 6:设计与评估 | 36–42 | docs/part-06-design-and-evaluation/ | 设计模式、评估、Benchmark、资源、安全、版本与回滚 |
| Part 7:Book Factory 与未来 | 43–47 | docs/part-07-future/ | 技术书工厂、内容角色、跨工具接力、内容派生与长期路线 |
当前全局登记的章节分段顺序可能因并行集成而不同;精确编号搜索比依赖文件中的物理顺序更可靠。
引用记录的最小检查
每条用于正文的引用至少回答以下问题:
| 字段 | 读者检查问题 |
|---|---|
REF-NNN | 编号是否能在共享引用表中精确定位? |
| 来源定位 | URL、论文、规范、版本或仓库位置是否足以找到原始材料? |
| 来源类型 | 这是官方资料、标准、论文、社区文章还是案例材料? |
| 支持的陈述 | 来源直接支持哪一句有限结论? |
| 不可外推 | 哪些产品、版本、权限、因果或效果不能从该来源推出? |
| 访问日期 | 动态资料是什么时候重读的?当前任务是否要求刷新? |
| 章节映射 | 哪个局部键和正文位置使用了它? |
| 冲突处理 | 若来源更新、失效或互相矛盾,由谁补证和决定? |
缺少关键字段时,不要自行补出一个“合理”来源。把陈述标为待核验、缩小结论或交给事实核验责任者。
一个完整追溯示例
第 45 章把 Codex 与 Claude Code 的产品事实分开登记:
- 正文用 REF-140 至 REF-144 标记有限产品陈述。
- 第 45 章局部参考资料保存 CH45-REF-01 至 CH45-REF-05、官方 URL、访问日期、允许用途和不可外推范围。
- 第 45 章事实核验逐条区分产品陈述、本书工程模型、教学输入和实际运行证据。
- 共享引用表保存跨章稳定的 REF 编号和登记摘要。
这个链条不表示两个产品行为相同,也不表示真实跨工具接力已经运行;它只让读者能够从正文主张回到受限来源和核验记录。
动态来源与失效处理
- 产品能力、API、版本、模型、价格和策略在写作或发布当日重新读取官方资料。
- 页面无法访问时,记录失败时间和影响;不要把缓存摘要或搜索片段静默当作原文。
- 来源内容变化时,先检查正文 claim 是否仍被支持,再更新共享登记、局部映射和事实核验。
- 旧来源仍有历史解释价值时可以保留,但应标明已替代、过期或仅限旧版本。
- 直接引语保持短且必要;摘要必须原创,并且不能扩大来源结论。
避免双重事实源
- 不在本附录重新维护完整 URL 表或
REF-NNN清单。 - 新增、删除、替换或重编号引用时,先更新共享引用表和使用该来源的章节工件。
- 本附录只在检索流程、目录结构或读者检查方式变化时更新。
- 若本页示例与共享登记冲突,以原始来源和共享登记为调查入口,并把冲突交给具名维护者;不要直接选择修改时间更新的文件。
术语的权威登记和查找路线见附录 K。
