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

1.3 KiB

DOC-011 每个递进例子只增加少量新概念

分类:示例与教学。级别:建议。本规则是项目写作约定,不是语言语义。

规则

递进示例围绕同一对象或任务,明确本次新增的变量。

原因

主题与命名稳定,使读者把注意力放在新增规则而不是重建业务背景。

执行方法

  1. 先展示基本形式,再加入一个参数、子节点或调用组合。
  2. 共用商品、价格与优惠的背景;确有必要换场景时交代原因。
  3. 独立参考页仍保留最小上下文,不强迫读者记忆整个教程。

改写对照

问题写法:从数字绑定突然跳到陌生的 Agent 工作流,且同时新增许多语法。

推荐做法:先绑定金额,再调用定价函数,最后组合两次调用。

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

验收

  • 新示例与前例差异明确。
  • 新增概念有对应解释。
  • 一致场景不会强制所有专业例子使用商品。

依据与边界

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

规则索引 · 检查清单