38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# DOC-014 比较方案时给出选择维度
|
|
|
|
分类：语义与边界。级别：条件。本规则是项目写作约定，不是语言语义。
|
|
|
|
## 规则
|
|
|
|
多个概念容易混淆或确有替代方案时，使用同任务、同输入和共同维度进行比较。
|
|
|
|
## 原因
|
|
|
|
比较要帮助理解或决策，而不是展示两段无关联代码。
|
|
|
|
## 执行方法
|
|
|
|
1. 先确定比较的是定位、阶段、结果还是使用情境。
|
|
2. 列出共同点、不同点与适用条件；表格只在映射确实有帮助时使用。
|
|
3. 未定语言方案的比较不等于替用户选择最终设计。
|
|
|
|
## 改写对照
|
|
|
|
问题写法：把 namespace key 与连接地址并列，却不解释职责差异。
|
|
|
|
推荐做法：分别说明归属 key 定位当前代码，use key 定位依赖，两者都不是传输连接。
|
|
|
|
以上是说明写作差异的项目例子，不新增语言能力。
|
|
|
|
## 验收
|
|
|
|
- [ ] 比较对象与维度明确。
|
|
- [ ] 读者知道差异是否影响用法。
|
|
- [ ] 没有为了比较而创造不存在的第二套 API。
|
|
|
|
## 依据与边界
|
|
|
|
[SRC-05](../research/SRC-05.md)、[SRC-06](../research/SRC-06.md)。来源页记录观察与分析，本页的执行方法是针对项目的综合建议，不宣称由某一原文逐项规定。
|
|
|
|
[规则索引](../README.md#规则索引) · [检查清单](../checklist.md)
|