每段写完先问这三个问题。内部文档常见的问题不是写得太少，而是没说清读者是谁，结果新手看不懂、老手嫌啰嗦，两边都不看。

给谁看决定写到什么深度。给新人的接入文档要把环境怎么装、第一个接口怎么调写透；给同组的接口说明，写清入参出参和边界就行，背景不用重复。我之前写一份部署文档，开头塞了半页项目由来，被同事吐槽「直接告诉我敲哪条命令」。

看完做什么最容易被忘。文档结尾最好给一句行动指引，比如「按第三节跑完就能本地起服务」，而不是甩一篇说明就结束。读者知道下一步干嘛，才愿意点进来。我自己的笔记也按这三问过，写着写着就发现哪些段落是写给自己的、哪些才是给别人看的。

写每段前过三遍：

  • 给谁看：新人 / 同组 / 外接方
  • 看什么：只要他此时该知道的那部分
  • 看完做什么：下一步动作一句话