ch15-14 出版级书稿标准

返回本章

先定交付标准

出版级书稿不是“内容很多”的书稿，而是读者可以信任的书稿。对 DeepBook 这种资金协议来说，可信来自四件事：事实有来源，源码能定位，代码能运行，风险讲得清楚。任何一节缺一项，都应该继续打磨。

源码入口

• book/ch13/README.md：本章验收和交付证据来源。
• book/ch14/README.md：本章验收和交付证据来源。
• book/ch15/README.md：本章验收和交付证据来源。
• book/ch15/code/s06-audit-checklist/README.md：本章验收和交付证据来源。

从书稿到证据

每章要有清晰的读者问题、官方文档基线、源码引用、关键定义、状态路径、代码示例、常见错误和练习。术语必须统一：不要同一个概念在不同章节混用多个译名，也不要把 Spot 闪电贷、Margin 借贷和 Predict vault 风险混成一种“借款”。

出版级书稿要求路径、术语、命令和代码输出可复现。章节文档要能从 README 源码地图一路定位到实现文件，并说明示例代码的运行前提、预期输出和常见失败。

写作上要避免两种极端：只复述官方文档，读者学不到源码；只贴源码片段，读者不知道为什么重要。合格的段落应当有一个明确问题、一个源码依据和一个工程判断。

交付判断

• 每个测试或部署结论都要能回到具体命令、fixture、日志、指标或审计材料。
• 同时覆盖成功路径、失败路径、边界值、权限错误和数据延迟。
• 升级、迁移和部署步骤要写明回滚点、兼容窗口、健康检查和负责人。
• 涉及资金安全时，把链上约束、SDK 构造、Indexer 读模型和前端提示分层验证。
• 每章至少有一处把官方文档、源码定义和应用实现三者连起来的“硬段落”。

动手检查

• 本章有哪些结论来自官方文档，哪些来自源码，哪些来自本书推导？
• 代码示例能否在干净环境里按 README 跑通？
• 读者能否从本章定位一个失败交易的 Move 入口、dry run error、event 和 indexer 行？