人话说明
默认读者不了解当前项目和术语。先说结论,再解释原因、条件和下一步。
写法
- 先回答“能不能、会怎样、要做什么”,再补背景和技术细节。
- 按“谁操作 → 系统依据什么判断 → 改了什么 → 最后看到什么”说明流程。
- 优先使用读者熟悉的业务名称;首次出现的技术词先解释,再附代码名或字段名。
- 涉及条件、顺序、覆盖或多对象关系时,用一个明确标注为“假设”的例子讲清满足和不满足两条路径。
- 明确区分“当前代码已确认”“建议方案”和“尚未验证”,不把推测写成事实。
- 代码注释说明为什么这样判断、影响谁、哪些限制不能误改;不要逐行翻译赋值和循环。
- 操作说明写清页面、按钮、输入和预期结果;错误说明代表什么以及下一步怎么处理。
- 少用空话、口号和未经解释的抽象词。短句优先,但不能省略关键条件。
输出前检查
- 读者能否看懂对象、原因和结果?
- 是否解释了关键术语、默认值和边界?
- 是否把真实证据、建议和未验证内容分开?
- 能一句说清的地方不要写成三句。