44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
# DOC-007 同时支持顺序阅读与按需查找
|
|
|
|
分类:结构与导航。级别:核心。本规则是项目写作约定,不是语言语义。
|
|
|
|
## 规则
|
|
|
|
目录、章节导航与主题索引共同提供学习和查询路径。
|
|
|
|
## 原因
|
|
|
|
新读者需要主线,熟悉的读者需要直接定位;单一大目录不能完全替代二者。
|
|
|
|
## 执行方法
|
|
|
|
1. 保持相邻章节导航和正文目录一致。
|
|
2. 为术语、具体语法与作者任务提供索引;用读者会搜索的名称。
|
|
3. 进入一个页面后能看出主题、相关详情和返回位置。
|
|
|
|
## 改写对照
|
|
|
|
问题写法:只提供文件列表,让读者猜先后关系。
|
|
|
|
推荐做法:正文有顺序目录,附录有术语与文法,手册另有问题索引。
|
|
|
|
以上是说明写作差异的项目例子,不新增语言能力。
|
|
|
|
## 验收
|
|
|
|
- [ ] 能从目录进入并返回。
|
|
- [ ] 指定术语能定位到主要定义。
|
|
- [ ] 作者资料不会混入语言学习主线。
|
|
|
|
## 具体应用
|
|
|
|
分别走查首页顺读、搜索直达和返回主定义三种路径。直接进入者需要一句局部上下文,而非完整复制前章;链接文字须能说明目标。
|
|
|
|
详见[三种入口](../references/information-architecture.md)与[定位验收](../references/review-rubric.md)。
|
|
|
|
## 依据与边界
|
|
|
|
[SRC-01](../research/SRC-01.md)、[SRC-07](../research/SRC-07.md)、[SRC-08](../research/SRC-08.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
|
|
|
[规则索引](../README.md#规则索引) · [检查清单](../checklist.md)
|