P83 · 输出格式与约束

按读者和目的调整内容

Audience-Purpose Content Calibration

先明确读者是谁、文章要帮助他们做什么,再决定内容深度。

编辑审核

以下示例与示意结果由本站编写,用于说明方法,不是模型实测结果。

使用场景

同一事故记录要写给决定是否延迟发布的负责人。教学事实:测试环境10次请求中2次失败;生产影响尚未知;根因未确认。读者需要评估发布风险,而非先读完整堆栈。

具体做法

明确读者、要作的决定、篇幅和语气。从给定证据选出影响、风险、建议及决策所需的缺口,先写这些,再提供可追溯技术附录。区分测试观察与生产事实,保留未知原因。技术团队版本可增加复现步骤,但基础事实和确定程度必须一致。

反例

把事故所有日志和堆栈逐段贴进高管简报,用技术细节证明已经掌握问题,直接说客户受到影响。

改进写法

为决定是否延迟发布的负责人写短简报:测试10次失败2次,生产影响与根因未知。先说明发布风险和建议补测的理由,再给证据位置及下一决策条件。完整日志放附录;不能把测试失败率当生产客户影响。

为什么这样改

读者的决定确定信息顺序与深度,减少他们自行翻译技术细节的负担。保留证据链接和未知项,使简洁不以夸大或删去关键事实为代价。

如何验证

教学简报应能定位2/10测试观察,明确生产未知,给出“取得生产范围或补测证据后再决定”的条件。将简报与技术附录逐项对照:环境、次数、根因状态应一致;没有证据的客户数量不得出现。

适用边界

受众变化只允许改变表达与重点,不能改变事实。高管、用户或工程师也未必各有固定篇幅;按具体决策需要调整。证据不足时建议应附条件,不能靠确定语气弥补。

原文与版本

如何收录这些方法

相关方法