为读者而写 是做什么的？
你的读者不在现场。他们了解领域，但不熟悉你的项目，而且习惯快速浏览。用词方面，请遵循“精简用语”原则。
- 编辑、校对或清理现有论文、报告或页面：请遵循
references/editing-pass.md，并将以下规则作为清单使用。 - 撰写或编辑论文：同时阅读
references/paper.md。
顺序
- 以结论引领： 发生了什么，影响多大。将新想法或能力作为标题；仅当比较本身是贡献时才以此开头。仅在需要引言时以问题开启；永远不要用通用的引言。不要叙述项目历史或执行记录。
- 标题陈述主张 在报告中（“更便宜的计划带来更多销量”而非“定价分析”）；长篇报告以编号结论列表开头。
- 摘要与TL;DR 保持高层级：用文字描述发现、读者会引用的数字、用文字说明空值、以及每个发现为何重要。匹配要求的长度。以读者能记住的清晰主张结尾。
- 邮件与交接 是简短的决策列表：要做什么、每个修复的难度、哪个选项手动工作最少。
- 正文自给自足。 在术语或比较对象首次出现的地方定义它们，永远不要首次出现在附录中。长篇报告以简短词汇表结尾。
内容
- 每个数字都要有对比参照： “25.6%的准确率（随机水平是10%）”。
- 说明发现的大小，即使很小。
- 每个发现展示一个真实示例。 保留案例研究、意外结果和已验证的阴性结果。
- 方法只在首次出现时解释一次： 一行说明如何操作；仅当读者会因此提问或被误导时才解释原因。披露定义人群或分母的排除条件；不要为常规选择辩解。
- 除非场地或用户要求，否则不要添加内容警告或关于自身流程的注释。 如果在看到结果后选择了阈值或子集，清楚陈述规则一次即可。
- 限制条件只在你所限制的主张旁边陈述一次，且仅当它会改变读者应相信的内容时。 保留定义结果的条件（“仅在2024年”）。在稳健性检验中的单一接近案例不会降低标题的重要性；但结论反转则会让标题失效。
- 缩小过度声明而非含糊其辞： 保留可靠部分，舍弃不可靠部分。
- 不要破坏发现。 不要承认比数据所显示更多的东西。除非会改变读者应相信的内容，否则不要添加没人要求的对比。如果检验削弱了故事，在含糊或放弃之前，先提议修复或扩展分析；不要自行更改分析。
- 没有密集段落。 一个段落只表达一个观点，并且能一次快速读完。将堆叠发现或条件的段落拆分；一连串数字应放入表格或列表。当条目是并列关系时，使用项目符号。
- 一个故事。 删除旁支故事。次要检验和例外只用一个正文句子说明；其细节进入附录。
- 同类相比。 来自不同数据集或不同人群的数字应放在各自的句子或表格中。永远不要将它们并排放置，好像一个有因果关系。
- 每项内容都必须证明自身价值。 每个词、句子、段落、列表项、章节、表格列、图形面板和说明文字必须改变读者的信念或他们的阅读方式。对每项内容问：没有它，读者会失去什么？如果什么都没有，就删掉；不要压缩。
- 每件事只说一次。 数字只存在于表格或文本中，不能同时存在；只存在于正文或附录中，不能同时存在。发现完整陈述一次；摘要、引言和总结只重复其关键数字。
- 不添加来源中没有的内容。 永远不要编造引文或结果；为作者留下标记占位符。
图形与表格
- 每个面板只传达一个文本无法同样好地传达的观点。使指标、更好的方向和基线一目了然。
- 使用真实名称，而非代码；最简单的图表；带有标题的坐标轴；一个标签方案，与说明文字和文本匹配。在序列所命名的内容旁边放置直接标签。
- 显示所有子集，或说明选择它们的规则。
- 在报告中，图形标题说明展示的内容。说明文字解释如何阅读它，并不重复方法。
在交付之前
以读者的身份阅读。对每个句子：他们会错过它吗？每个数字是否回答了“与什么相比”？然后运行“精简用语”。不要更改任何数字。如果缺少某些内容或两个数字不一致，请告知作者而不是自行填补空白。