规范导读
如何阅读规范
这篇文章要回答什么?
Section titled “这篇文章要回答什么?”Specifications这一章在整个文档站里承担什么职责。- 规范文与白皮书、工程文档分别有什么分工。
- 这一章应该如何阅读、如何查阅、如何引用。
这一章不负责什么?
Section titled “这一章不负责什么?”写作提示:
- 说明它不承担项目动机论证,那是
Whitepaper的职责。 - 说明它不承担工程实现与 API 教程,那是
Engineering的职责。 - 说明它也不是新读者的 onboarding 入口,那是
Start Here的职责。
这一章负责什么?
Section titled “这一章负责什么?”写作提示:
- 说明它定义的是 Proto UI 的正式语义与契约边界。
- 说明它需要同时服务原型作者与适配器作者。
- 说明它更适合被查阅、引用与裁决歧义,而不是连续读完。
建议如何阅读这一章?
Section titled “建议如何阅读这一章?”写作提示:
- 给首次进入规范区的读者一个建议顺序,例如先读
Core,再按能力逐项阅读。 - 告诉读者每篇规范文前半适合顺读,后半适合按需查阅。
- 告诉读者当问题涉及“为什么要这样设计”时,应回到
Whitepaper。
每篇规范文建议使用统一结构
Section titled “每篇规范文建议使用统一结构”写作提示:
- 摘要:这项规范定义什么,解决什么语义问题。
- 术语:本篇使用的核心术语。
- 对原型作者意味着什么。
- 对适配器作者意味着什么。
- 正式语义。
- 有效行为 / 无效行为 / 未定义行为。
- 与其他规范的关系。
这篇要把读者带到哪里?
Section titled “这篇要把读者带到哪里?”写作提示:
- 把读者带到
Core,作为具体规范阅读的起点。