写技术文章时,怎样让别人一眼看懂你的上下文

很多文章不是内容不够,而是读者不知道你面对的到底是什么问题。

一个更稳的结构

1. 先说背景
2. 再说问题
3. 然后给方案
4. 最后交代结果和代价

不要省略这些信息

  • 版本号
  • 运行环境
  • 约束条件
  • 为什么没选别的方案

代码块别只贴结果

const result = await service.run(task);
if (!result.ok) throw new Error(result.message);

代码前后最好都补一句:这段代码解决了什么,以及它依赖什么前置条件。

一个小标准

如果读者读完标题、摘要和每个二级标题就知道全文怎么走,这篇文章的结构通常已经合格。