38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# DOC-006 按读者问题分页
|
|
|
|
分类:结构与导航。级别:核心。本规则是项目写作约定,不是语言语义。
|
|
|
|
## 规则
|
|
|
|
一页承担一个主要主题或任务;按独立查阅需要拆分,而不是按固定字数或每句话拆分。
|
|
|
|
## 原因
|
|
|
|
好的边界既支持定位,也保留理解当前主题所需的上下文。
|
|
|
|
## 执行方法
|
|
|
|
1. 可以独立命名和查阅的内容单列页面。
|
|
2. 类型声明与取得数据是不同问题;类结构和数据读取分别成章。
|
|
3. 短而紧密依赖的子项保留在同页,避免制造大量空壳或跳转。
|
|
|
|
## 改写对照
|
|
|
|
问题写法:把所有类声明、读取、界面更新和失败方案放在同一章。
|
|
|
|
推荐做法:将结构、读取和渲染分开,并在使用点连接。
|
|
|
|
以上是说明写作差异的项目例子,不新增语言能力。
|
|
|
|
## 验收
|
|
|
|
- [ ] 页名说明主题,不叫“更多”或“其他”。
|
|
- [ ] 拆分页仍可独立阅读。
|
|
- [ ] 没有仅因字数达到阈值而拆分。
|
|
|
|
## 依据与边界
|
|
|
|
[SRC-09](../research/SRC-09.md)、[SRC-14](../research/SRC-14.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
|
|
|
[规则索引](../README.md#规则索引) · [检查清单](../checklist.md)
|