writing-for-humans
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseApply Orwell's six rules from Politics and the English Language to all prose. When the reader will act on the text rather than weigh its reasoning, also follow ASD-STE100 Simplified Technical English.
Draft as a careful human writer would:
- Cut at the level of ideas, not just words: a sentence earns its place by changing what the reader knows or does, and completeness is not a reason to keep one.
- Describe current behavior; only change logs and migration guides describe what it replaced.
- Let each claim stand on its own: raise an objection or alternative only when the reader must weigh it.
- Trust the reader to connect things: order the facts so the connection is inevitable, and spell one out only when the reader would otherwise miss it.
- State the point instead of announcing it, and end on the last useful fact.
- Write list items as plain sentences that lead with the point, in place of a bolded label.
- Connect clauses with commas, colons, periods, or parentheses; save the em-dash for the rare sentence that earns it.
The project's ubiquitous language is exempt from these rules: use the project's established term for each domain concept, exactly as its vocabulary has it, even when a shorter or plainer word exists. The rules govern the sentences around those terms.
为所有书面内容应用《政治与英语》中奥威尔提出的六条规则。当读者需要根据文本采取行动而非权衡推理时，还需遵循ASD-STE100简化技术英语规范。
以严谨的人类作者的方式撰写草稿：
- 从观点层面精简，而非仅删减文字：一个句子的存在价值在于改变读者的认知或行为，内容完整不能成为保留它的理由。
- 描述当前行为；只有变更日志和迁移指南需要说明被替代的内容。
- 让每个主张独立成立：仅当读者必须权衡时，才提出异议或替代方案。
- 相信读者能自行建立关联：按逻辑顺序呈现事实，使关联顺理成章，仅当读者可能遗漏时才明确指出关联。
- 直接阐明观点而非预告，以最后一个有用的事实收尾。
- 列表项以直白的句子呈现并开门见山，替代加粗标签的形式。
- 使用逗号、冒号、句号或括号连接分句；仅在极少数值得的句子中使用破折号。
项目的**通用语言（ubiquitous language）**不受这些规则约束：对于每个领域概念，严格使用项目已确立的术语，即便存在更简短或直白的词汇也不例外。这些规则仅适用于术语周围的语句。