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

1.6 KiB

DOC-018 使用独立成立的文档陈述

分类:表述与证据。级别:核心。本规则是项目写作约定,不是语言语义。

规则

正文陈述概念和规则,不记录作者与用户的对话过程。

原因

读者不应该依靠之前的讨论理解今天的用法。

执行方法

  1. 把“你之前说”“先这样”“以后再看”等过程叙述移出语言正文。
  2. 用对象、动作、条件和结果构成明确句子;保留教程所需的直接操作指令。
  3. 待定项目使用集中状态,不让“不能”“不是”成为每段唯一内容。

改写对照

问题写法:我们上次说过,这里先这样写,以后再讨论。

推荐做法:该声明定义字段结构;读取成员的声明形式列于规范状态。

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

验收

  • 移除聊天历史后仍可理解。
  • 代词指向明确。
  • 使用第二人称教学指令本身不被误判为问题。

具体应用

先提取原稿真正表达的断言,再写对象、行为、条件与后果。保留必要概念,删除必须依赖聊天才能理解的指代;合理的教程第二人称可保留。

详见独立陈述与完整改写。

依据与边界

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

规则索引 · 检查清单