爲讀者而寫
你的讀者並沒有親身參與。他們熟悉該領域，但不知道你的專案細節，而且他們會快速瀏覽。關於用詞選擇，請套用 plain-words。
- 編輯、校對或清理現有的論文、報告或頁面：請遵循
references/editing-pass.md，並將以下規則作為檢查清單。 - 撰寫或編輯論文：也請參閱
references/paper.md。
順序
- 以發現開頭： 發生了什麼事，以及規模有多大。將新的想法或能力作為標題；只有在比較本身就是貢獻時，才以比較作為開頭。只有在需要引言時才提及問題；絕不使用泛泛的引言。不要敘述專案歷史或執行過的記錄。
- 標題應陳述主張（例如「更便宜的方案銷量更高」，而非「定價分析」）；較長的報告應以編號的發現列表開頭。
- 摘要與TL;DR 應保持高層次：用文字描述發現、讀者會引用的數字、用文字說明的空值，以及每個發現重要的原因。符合要求的長度。以讀者會記住的簡單主張作結。
- 電子郵件與交接文件 應是簡短的決策清單：要做什麼、每個修復的難度、哪個選項需要最少的人工操作。
- 正文應能獨立存在。 在第一次出現時定義每個術語和比較對象，絕不能先在附錄中定義。較長的報告應以簡短的詞彙表結尾。
內容
- 每個數字都要有比較基準：「準確率 25.6%（隨機猜測為 10%）」。
- 說明發現的影響有多大，即使很小。
- 每個發現展示一個真實範例。 保留案例研究、驚喜發現和已驗證的負面結果。
- 方法只在首次出現的地方說明一次： 一行說明如何做；只有在讀者可能會問或產生誤解時才說明原因。揭露定義群體或分母的排除條件；無需為常規選擇辯護。
- 除非場所或用戶要求，否則不要加內容警告或關於自身流程的備註。 如果某個閾值或子集是在看到結果後才選定的，請明確陳述規則一次。
- 限制條件只陳述一次，放在它所限制的主張旁邊， 且僅在它會改變讀者應相信的內容時才這樣做。保留定義結果的條件（例如「僅限 2024 年」）。單次接近但未通過穩健性檢驗的結果不應降低標題的重要性；但結果反轉則會。
- 縮小過度宣稱的範圍，而非模糊處理： 保留確定的部分，刪除不確定的部分。
- 不要破壞發現。 不要承認超出數據所顯示的內容。除非會改變讀者應相信的內容，否則不要添加無人問起的對比。如果某項檢查削弱了故事，應先提議修正或擴展分析，而非模糊處理或放棄；不要自行更改分析。
- 不要有密集的段落。 一個段落只說明一個觀點，且能讓人一次讀懂。將堆疊了發現或條件的段落拆分；一串數字應放入表格或列表。當項目是並列關係時，可以使用項目符號。
- 一個故事。 刪除次要故事。次要檢查和例外只在正文中用一句話說明；其細節放入附錄。
- 同類比較。 來自不同數據集或不同人的數字應放在各自的句子或表格中。切勿將它們並列，彷彿其中一個導致了另一個。
- 每個元素都必須證明其存在的必要性。 每個字詞、句子、段落、列表項目、章節、表格欄位、圖表面板和標題子句都必須改變讀者的認知或閱讀方式。對每個元素提問：沒有它，讀者會失去什麼？如果什麼都不會失去，就刪除它；不要壓縮它。
- 每件事只說一次。 一個數字只能存在於表格或文字中，不能兩者皆有；只能存在於正文或附錄中，不能兩者皆有。一個發現完整陳述一次；摘要、引言和結論只重複其關鍵數字。
- 不要添加來源中沒有的內容。 切勿捏造引用或結果；留下標記好的佔位符供作者填寫。
與圖表
- 每個面板應說明一個文字無法同樣有效說明的觀點。明確顯示指標、較佳方向以及基準。
- 使用真實名稱而非代碼；最簡單的圖表；帶有標題的座標軸；統一的標籤方案，並與圖註和文字一致。在數列旁放置直接標籤。
- 顯示所有子集，或說明選擇它們的規則。
- 在報告中，圖表標題說明顯示的內容。圖註說明如何閱讀，且不重複方法。
交稿前
以讀者的角度閱讀。對每個句子：如果少了它，讀者會覺得可惜嗎？每個數字是否說明了「與什麼相比」？然後執行 plain-words。不要更改任何數字。如果缺少某些內容或兩個數字不一致，請告知作者，而不是自行填補空缺。