1.3 KiB
1.3 KiB
DOC-016 区分语言模型与实现机制
分类:语义与边界。级别:核心。本规则是项目写作约定,不是语言语义。
规则
语言文档描述源码与应有效果,系统实现资料另行组织。
原因
执行机制可以变化,用户需要依赖的是语言意义与可观察行为。
执行方法
- 说明声明、参数和结果,不要求业务用法配置 HTTP、缓存或监听器。
- S3 仅解释代码存储约定,不据此定义业务数据后端。
- 比较概念时明确层次,不能把 namespace、应用角色与处理阶段互相替代。
改写对照
问题写法:用传输协议和固定绘制命令解释函数和组件的语言规则。
推荐做法:说明函数结果、数据依赖和组件排列效果,不绑定具体编排方案。
以上是说明写作差异的项目例子,不新增语言能力。
验收
- 没有出现开发软件代称。
- 实现选择没有伪装成语法限制。
- 必要的存储说明限定在代码组织范围。