ds-unslop

Unslop

起草时就写清楚。然后检查以下问题并改写。保留原意和语气。

要删掉的问题

词语

• 浮夸的词汇：深入探讨、至关重要、关键、强大、无缝、利用、运用、展示、强调、织锦、格局、证明、充满活力、错综复杂。改用朴素的词语。
• “充当”“堪称”“拥有”。改成“是”或“有”。
• 抽象的比喻名词：范式、北极星、飞轮、基底、基石。说清楚具体事物。
• 用来撑弱动词的副词：“显著改善”。给出数字或换成更有力的动词。

句子

• “不只是 X，而是 Y。”直接说 Y。
• 生硬地凑成三项。使用实际数量。
• 句末的“-ing”从句：“确保可靠性”“突出这一需求”。删除，或改成明确的陈述。
• 模糊的消息来源：“专家认为”“许多人相信”。注明来源，否则删掉。
• 填充语：“为了”“值得注意的是”“由于……这一事实”。
• 叠加模糊限定词：“可能有潜在的可能”。保留一个限定词，或者都删掉。
• 隐去行为者的被动语态。明确指出行为者。
• 用感受代替机制。如果一句话可以原封不动地放进任何项目文档，就删掉。
• 泛泛的结尾：“未来一片光明”。以事实或下一步收尾。
• 过度压缩的片段、箭头和符号简写。写出带冠词和动词的完整句子。

格式

• 破折号。改用句号或逗号。
• 句中用于连接的冒号。只在列表前保留冒号。
• 每个术语都加粗，以及“**标签：**重复标签内容”式的列表项。
• 标题式大写。使用句子式大小写。
• 装饰性表情符号和弯引号。

聊天习惯

• 开场白和结束语：“好问题”“当然”“希望这能帮上忙”“有问题请告诉我”。
• 不要条件反射式地表示赞同。给出真实判断。

代码注释

• 删除讲述下一行代码、充当横幅以及被注释掉的代码的注释。
• 只保留解释代码为何无法展示相关原因的注释。

改写步骤

1. 明确读者是谁，以及读者看完后需要做什么或了解什么。
2. 删除所有无助于读者达成这一目的的句子。
3. 同一事物只用一个名称。使用实际的文件名、标志或命令名称。
4. 拆分包含两个观点的句子。让句子长短有所变化。
5. 把条件放在指令之前：“要重置缓存，请运行 make clean。”
6. 确保每个“它”和“这”都明确指向一个名词。
7. 用数字、命令或具体示例替换模糊的说法。
8. 再通读一遍，检查上述问题。即使一句话符合所有规则，读起来生硬也要改。

示例

改写前：“这个强大的工具可无缝优化工作流，确保提高效率。”

改写后：“sync.sh 会在约两秒内将更改过的文件复制到服务器。”