一份好笔记,首先要让未来的自己看懂。Markdown 的作用是用少量标记表达结构,让内容可以在不同编辑器之间移动。
从一个明确的问题开始
标题尽量描述具体问题,例如“如何整理每月账单”,比“整理笔记”更容易检索。开头用两三句话说明这份笔记适用于什么场景,以及完成后会得到什么。
保持简单的层级
文章标题由页面提供,正文从二级标题开始。每个小节只回答一个问题。操作步骤用有序列表,平行的注意事项用无序列表。只有需要比较多项信息时,才使用表格。
## 操作步骤
1. 收集原始文件。
2. 按月份建立目录。
3. 检查文件是否可以打开。
代码、文件名和命令放进代码格式;解释写在代码块前面。这样复制内容时,不会把说明文字一起带走。
给来源留一个位置
引用网页时,保留页面标题和链接。如果结论与某个版本或日期有关,也一并写清。自己的试验结果与文档中的说明可以分段记录,避免过一段时间后分不清它们的来源。
写完后做一次回看
关掉原始资料,只读这份笔记,检查步骤是否完整。删掉没有帮助的重复表达,并补上当时觉得“显然”、后来可能忘记的前提。笔记不必长,但应当可以再次使用。