写技术笔记的几个小习惯

笔记是写给自己看的，但「写给未来的自己」和「写完就忘」差别很大。下面几条是我踩过坑后留下的习惯。

代码块永远标注环境

半年后你只记得「当时在某个服务器上跑过」，却忘了是哪个系统、哪条命令。所以代码块旁边尽量写清上下文：

# 在 ECS（CentOS 7）上执行
sudo yum install -y nginx

不标注环境的命令，等于没写的命令。

用列表拆解步骤

一长段操作描述，远不如编号列表好读。按时间顺序把动作拆开：

1. 登录服务器
2. 安装并启动服务
3. 放通安全组与防火墙
4. 本地验证端口

把「坑」单独记下来

顺利的步骤容易忘，卡住的地方才值得记。凡是让你多花了 10 分钟以上的，都值得留一行：

• connection refused ≠ 安全组没开，往往是服务没起
• 改完 Nginx 配置要 nginx -t && systemctl reload nginx

结论前置

每篇笔记开头用一两句话先给结论，后面再展开。这样日后检索时，扫一眼开头就能决定要不要点进去。

把这些习惯固化成模板，写新笔记时就只需要填内容，省下的精力能多记好几篇。

← 返回首页