通用写作技巧

1-minute read
写作

生活不可能像你想象得那么好，但也不会像你想象得那么糟。我觉得人的脆弱和坚强都超乎自己的想象。有时，我可能脆弱得一句话就泪流满面，有时，也发现自己咬着牙走了很长的路。 ——莫泊桑《羊脂球》

元信息 🔗︎

在写作之前，简要说明你要写的内容，并根据读者的不同调整表达方式。

  • 目标：让内容对不同背景的读者都清晰易懂。
  • 方法：对于非技术读者，尽量使用简单语言解释复杂概念；对于技术读者，可以适当深入细节。

段落结构 🔗︎

每个段落必须有一个开场白句子，明确本段落的中心思想。

  • 你想表达的是什么：明确主题。
  • 为什么这很重要：说明意义或价值。
  • 读者应该如何利用这些知识：提供实际应用场景或建议。

句子原则 🔗︎

  1. 单一性原则：避免在一个句子中同时表达多个意思（如"和这个与和那个"）。
  2. 简洁表达：删除冗余词语，确保句子清晰明了。

行话与认知语境 🔗︎

  • 如果涉及专业术语或行话，请提供一个优质链接，指向相关解释。
  • 假设读者比你知道得少，避免初学者感到困惑。
  • 示例：
    • 技术术语：“JavaScript是一种单线程语言。” → 什么是单线程？
    • 非技术术语：“JavaScript一次只能做一件事。”

常见问题及改进建议 🔗︎

1. 少用代词，避免歧义 🔗︎

  • 示例：
    • 错误：“它运行得很快。”
    • 改正：“代码运行得很快。”

2. 避免习语 🔗︎

  • 示例：
    • 错误：“我们一箭双雕。”
    • 改正：“我们同时解决了两个问题。”

3. 表达简洁 🔗︎

  • 删除冗余表达，例如"在某地存在一个"或"在某地存在多个"。
  • 示例：
    • 原句：“在软件和硬件之间有很多重叠的地方。”
    • 改后：“软件和硬件有很多重叠的地方。”
    • 原句：“在JavaScript中不存在多线程。”
    • 改后：“JavaScript没有多线程。”

4. 少用形容词和副词 🔗︎

  • 示例：
    • 错误：“在生产模式中，代码运行速度极其快。”
    • 改正：“在生产模式中，代码运行效率将提升225%。”

5. 使用列表 🔗︎

  • 有序列表：用于步骤或流程。
  • 无序列表：用于并列内容。

6. 列表结构保持平行 🔗︎

所有列表项目应保持一致：

  • 语法和标点符号：统一格式。
  • 逻辑分类：确保列表项属于同一类别。
  • 大小写规则：保持一致。

错误示例： 🔗︎

  • c++
  • JAVASCRIPT？
  • Rust！
  • 巧克力片饼干（chocolate chip cookies）

正确示例： 🔗︎

  • C++
  • JavaScript
  • Rust
  • Python

7. 使用主动句 🔗︎

  • 示例：
    • 错误：“故事是由我写的。”
    • 改正：“我写了一个故事。”

写作技巧 🔗︎

迭代文档 🔗︎

  1. 统一风格：根据内容选择严谨、准确或口语化的风格。
  2. 确定目标用户：明确你的读者是谁，以及他们的背景知识。
  3. 停顿再修改：写完后暂停一段时间，再回头检查，甚至大声朗读文章。
  4. 找伙伴校对：请他人帮助检查文章，发现潜在问题。

文档组织 🔗︎

  1. 内容范围：明确包括哪些内容，需要读者具备哪些背景知识，不包括哪些内容。
  2. 系列短文优于长文：分模块讲解更易于理解。
  3. 理论+实践：结合概念与实际应用，展示如何落地。
  4. 循序渐进：从基础到高级，逐步展开。
  5. 目录结构：最好提供目录，方便读者快速定位。

配图建议 🔗︎

  1. 标题简洁：吸引读者注意，描述核心要点。
  2. 信息适量：避免图表信息过多，最好添加标注。
  3. 视觉清晰：确保配图与文字内容相辅相成，增强理解。