1.7 KiB
1.7 KiB
DOC-005 按概念依赖安排阅读顺序
分类:结构与导航。级别:核心。本规则是项目写作约定,不是语言语义。
规则
章节顺序由理解前提决定,不由实现顺序、聊天顺序或文件创建时间决定。
原因
顺序阅读需要已经介绍的概念支持新概念;反复前后跳转会中断理解。
执行方法
- 为主题列出必要前置概念,先排依赖再排应用。
- Endorphin 主线先讲身份与 namespace,再讲导入、阶段、语法与应用。
- 概览可以预览后文,但预览应简短且注明详情入口;正式规则不要依赖未解释术语。
改写对照
问题写法:在身份与导入之前,先要求读者理解跨 namespace 的数据调用。
推荐做法:先定义定位与引用,再解释调用和结果依赖。
以上是说明写作差异的项目例子,不新增语言能力。
验收
- 正文前后顺序能说明理由。
- 重要术语在正式使用前已定义或链接。
- 目录调整没有改变语言语义。
具体应用
列出主题的理解前提,再为每条目录路径走查;预览允许先出现,但正式解释必须能回到定义。移动时保留旧内容到新位置的映射。
依据与边界
SRC-03、SRC-09、SRC-15。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。