把一段命令复制到笔记里,并不意味着以后就会使用它。几周后再打开,最常见的疑问往往是:这条命令在哪台机器执行?它改了什么?当时为什么需要它?
用问题作为标题
“Nginx 笔记”很难在一堆文档里被准确找出来。“Nginx 配置改完后如何验证并重载”就具体得多。标题里放入未来会搜索的关键词,通常比追求漂亮的分类更有用。
环境只记关键差异
操作系统、软件版本、运行方式和相关路径,往往足以解释大部分差异。无需把整个环境信息全部贴上来,但会改变命令含义的条件应该说明。
例如同样是启动服务,Docker Compose 和 systemd 的命令不同;同样是文件权限,容器内的用户 ID 和宿主机的用户名也可能不同。
命令旁边写预期结果
一份简短模板可以这样组织:
# 要解决的问题
## 环境与前提
## 操作步骤
## 预期结果与验证
## 回退方法
## 参考资料
验证结果最好具体到状态码、输出字段或可见行为。“看起来正常”很难复查,“首页返回 200,缺失路径返回 404”就清楚得多。
失败步骤也有价值
没有必要保留所有试错日志,但值得记下关键误区:为什么某种方法不适用,哪一个证据推翻了原来的判断。以后遇到相同症状时,这些信息能减少重复尝试。
最后,发布前再检查一次敏感信息。真实密码、令牌和内部地址可以替换为明确的示例值;保留解释问题所需的结构就够了。