给下一次遇到问题的自己，写一份笔记
记下背景、尝试和最终答案。好的技术笔记，不只是一串复制粘贴的命令。
先说明当时发生了什么
这是一篇技术笔记示例。排查问题时，最容易漏掉的往往是背景：运行环境是什么，原本期望什么，又实际看到了什么。没有这些信息，几个月后的自己也很难看懂留下的命令。
可以先写三句话：想完成的事情、遇到的现象，以及能够复现问题的条件。把问题说清楚，通常也是找到答案的第一步。
保留有用的过程
笔记不必记录每一次敲键盘。更值得留下的是做过哪些判断、用什么证据排除了某个原因，以及哪个变化真正带来了不同结果。
涉及日志和配置时，先检查是否包含密码、令牌、个人地址等敏感内容。公开文章可以保留结构，但不应该公开真实凭据。
最后留一个验证方法
不要只写问题已经解决。补上一条可以再次执行的检查方式，并说明预期看到什么。如果方案有适用条件或已知限制，也一并写下来。
这样一份笔记既可以帮助别人，也能让未来的自己少走一次相同的弯路。
写在这里，留待日后。回到顶部 ↑