Endorphin-Document/authoring/rules/DOC-002.md

DOC-002 确定页面的主要职责

分类：读者与定位。级别：核心。本规则是项目写作约定，不是语言语义。

规则

页面先选择教程、操作指南、参考或概念解释中的主要职责，再决定组织方式。

原因

不同读者任务需要不同信息；把学习步骤、精确规则与设计争论混在一起，会破坏查阅路径。

执行方法

1. 教程带读者完成一次受控练习；操作指南解决一个明确任务。
2. 参考集中给出形式、参数、约束和结果；解释说明概念关系与选择理由。
3. 一页可以包含少量辅助说明，但次要内容不改变其主线；用互链代替重复。

改写对照

问题写法：函数章节同时记录全部提案争论、部署步骤和关键字表。

推荐做法：函数用法留在正文，完整文法与未定设计分别链接附录。

以上是说明写作差异的项目例子，不新增语言能力。

验收

• 可用一句话说明该页主要用途。
• 标题与正文职责一致。
• 无需为了分类创建没有内容的四套目录。

依据与边界

SRC-14、SRC-11。来源页记录观察与分析，本页的执行方法是针对项目的综合建议，不宣称由某一原文逐项规定。

规则索引 · 检查清单