3.6 KiB
页面与章节的信息架构
本方法用于新章、首页和目录重组。读者目标决定信息位置,文件长度只是发现问题的线索。
先写一张页面卡
用一句话填写“已知道什么的读者,在什么情境下,读完能做什么”。再列出主定义、必要前提和可检查结果。
例如:“知道 key 组成的读者,要引用定价逻辑,读后能写出完整 use,并区分依赖来源与自身归属。”它会导出 use 写法、双方 key、引用效果与可见性边界,不需要先讲网络实现。
同一页若同时承担“解释为什么使用 namespace”和“查找 use 的精确约束”,可以保留简短背景,但应有清楚的查询小节或互链。只有当两种读者任务互相妨碍时才拆页。
决定信息属于哪里
| 信息 | 首选位置 | 判断依据 |
|---|---|---|
| 概念是什么、解决什么问题 | 指南首次介绍处 | 首次读者需要建立模型 |
| 完整形式、约束、结果 | 对应参考小节及集中 EBNF | 跳转读者需要精确查询 |
| 关键例子成立的假设 | 例子之前或紧邻例子 | 离开此条件会误读合法性 |
| 尚未决定的完整清单 | 规范状态附录 | 避免各章多份状态互相漂移 |
| 实际影响例子的未定项 | 局部短注并链接状态 | 读者不应读到页末才发现例子有前提 |
| 写作讨论、来源研究、审查记录 | authoring | 维护作者需要,语言学习主线通常不需要 |
从提纲判断是否可读
将所有小节标题连起来读,检查它们是否回答连续的问题。例如“key 是什么 → 如何分解 → 如何确定归属 → 如何引用其他代码 → 哪些规则还未定义”。
标题应提供信息线索。“其他”“相关说明”“注意事项”通常需要改成具体主题,如“导入不改变代码归属”。章节编号承担顺序,不替代可搜索的主题词。
先定义再使用不要求所有章节线性展开。概览可以先预览用途,再链接定义;跳转页可以用一句话补足前提。避免通过复制整章解决前置知识问题。
拆分与合并的判断
满足以下情形时优先考虑拆分:读者目标明显不同;可独立修改与查询;不同前提让一组读者长期跳过大半页面。以下情形通常保留同页:例子离开解释就失去意义;两页必须来回跳转才能理解一个最小规则;拆分后只有标题和链接。
拆分前制作映射:“旧小节 → 新文件或锚点 → 需要更新的引用”。更新目录、相邻导航、术语、状态和文法引用。文件重命名会影响已分享的地址;需要保留历史访问入口时使用真实可用的重定向或短入口页,并在任务中说明,不能只假设站点会处理。
单页的阅读负担
第一段回答对象及职责。第一个例子只承担本页的主要目标。正文解释会影响理解的差异,不逐行翻译所有标点。表格适合重复字段对照,段落适合原因和行为关系。
以段落为单位删除后检查:删去是否让读者无法判断用途、合法性、结果或下一步?若都没有影响,这段可能应删去或移入深读链接。反过来,短文若缺少关键前提仍需补足。
复查三个入口
- 从全书目录首次进入:前置概念是否已出现?
- 从搜索直接进入小节:能否识别对象、状态、条件和结果?
- 从相邻概念返回:是否找到唯一主定义,还是读到不同版本?