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

1.3 KiB

DOC-021 每次改动完成影响检查

分类:协作与质量。级别:核心。本规则是项目写作约定,不是语言语义。

规则

文档修改同时检查关联定义、示例、导航与状态,不以改完当前文件作为结束。

原因

局部正确不代表整套文档一致,尤其是同一写法在多个位置出现时。

执行方法

  1. 修改前找出主定义和引用位置,编辑后复查影响范围。
  2. 运行链接、锚点、代码块、编号和格式检查;按风险检查例子与计算。
  3. 报告实际检查等级、未执行步骤与失败;工具通过不等于语言运行验证。

改写对照

问题写法:修改 use 示例后只检查当前段落。

推荐做法:同步正文、文法、索引和所有相关示例,并记录验证范围。

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

验收

  • 相关引用无过时版本。
  • 命令和结果可复现。
  • 报告没有把静态检查称为编译或运行测试。

依据与边界

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

规则索引 · 检查清单