Files
Endorphin-Document/authoring/rules/DOC-008.md
T

1.3 KiB

DOC-008 稳定编号与唯一主定义

分类:结构与导航。级别:核心。本规则是项目写作约定,不是语言语义。

规则

规则 ID 固定,概念只有一个主要定义来源;目录位置和显示编号不作为规则身份。

原因

重排页面不应使长期引用失效,重复定义也会造成版本分歧。

执行方法

  1. 重要写作规则使用 DOC 编号,来源使用 SRC 编号,模板使用 TPL 编号。
  2. 修改规则内容保留 ID;废弃时保留说明或定向链接,不将旧 ID 分配给其他规则。
  3. 语言文法集中在一个附录,正文只解释相关用法并连接主定义。

改写对照

问题写法:把每章完整复制的文法当作各自独立版本。

推荐做法:一份完整 EBNF 为主来源,章节连接对应产生式。

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

验收

  • ID 唯一且不因排序变化而更换。
  • 定义页可定位。
  • 相同规则没有多份相互矛盾的权威描述。

依据与边界

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

规则索引 · 检查清单