一份清楚的 Markdown 笔记,应该包含什么?
原创示例文章,用于体验博客;可在创作中心编辑和管理。
写笔记时,最容易省略的是自己当时已经知道的部分。几周之后,省略的恰好可能是重新理解这篇笔记的关键。
先说明要解决的问题
第一段交代遇到了什么、想得到什么结果。不要只写一个工具名称,而是写清使用它的原因。
比如“整理一批文件”比“文件工具”更具体;“把一批截图按日期归档”又能进一步限定范围。
区分操作与观察
操作写做了什么,观察写发生了什么。命令、环境和结果分开记录,别人才能判断是否适用于自己的情况。
## 问题
需要完成的具体任务。
## 操作步骤
1. 准备输入。
2. 执行操作。
3. 检查结果。
## 结果与限制
观察到的结果,以及尚未验证的部分。
给未来的自己留下出处
引用外部观点时保留来源。记录代码时注明使用环境,尤其是依赖版本。对暂时没有弄清楚的地方,直接写“待确认”,不必把推测改写成确定结论。
笔记并不需要完美。清楚地说明问题、过程和边界,就已经是一份值得留下的记录。