打开文档导航

本科生版解释写作合同

受众

默认读者学过基础 Python、操作系统和网络,但没有 capability security、WASM runtime 或 Agent runtime 研究背景。目标是让读者形成正确直觉,并保留继续读源码所需的术语。

每篇固定结构

  1. 一句话: 直接回答文件标题提出的问题。
  2. 先看一个例子: 使用一个可跟随的小场景,不连续堆多个类比。
  3. 真实机制: 把例子中的角色映射回 Pysolate 对象和执行顺序。
  4. 为什么重要: 分开写技术影响和产品/业务影响;没有真实业务数字时不得编造。
  5. 不能推出什么: 只保留最可能造成误判的限制。
  6. 术语卡: 3–6 个本篇首次出现的 canonical terms。
  7. 继续阅读: 链接前置/后续解释、现有说明文档和源码 owner。

第一屏通常用 600–1200 个中文字回答核心问题。完整正文可以更长,但每篇仍只讲一个问题;API 表、固定 SHA、资源上限和 evidence producer 细节应尽量下沉到实现说明。

证据纪律

  • 运行时事实以 agent-python-runtime 的冻结 target 为准;当前基线见根 README.md
  • pysolate-explained 的既有文档是调查索引,不自动替代源码证据。
  • 保留 Current、Observed、Historical、Framing、Deferred、Unsupported 的证据状态。
  • candidate/AST 不产生 authority;physical completion 不等于 logical effect。
  • receipt 记录 Host 观察,不证明外部世界最终状态。
  • digest 证明 canonical bytes identity,不证明语义正确性、作者身份或 zero-copy。
  • fixed fixture、schedule model 和历史 artifact 不得升级为生产性能结论。

风格

  • 像耐心的高年级同学,不使用幼儿口吻。
  • 第一次出现术语时写成“术语(人话解释)”;之后保持同一名称。
  • 每篇只使用一个主类比。类比会掩盖 authority、identity 或失败状态时,改用具体执行例子。
  • 不复刻现有审查文档的长 source map;正文讲机制,文末给导航。
  • 不使用“其实很简单”“显然”等贬低读者困惑的表达。
  • 不为了显得完整而堆叠 SHA、测试名和审计措辞。

单篇完成门

  • 普通本科生能用两三句话复述核心机制。
  • Host、Guest、共享对象和私有对象的 owner 没有写反。
  • happy path 至少配一个最重要的失败或未命中路径。
  • 所有实现状态和性能表述都没有超过现有证据。
  • 前置、后续、现有文档和源码导航链接有效。