← 返回笔记列表
Writing / Markdown

给 Markdown 笔记留一点结构

记录的价值不在于写了多少,而在于隔一段时间再打开时,仍然知道自己当时在解决什么。

先写下那个问题

开始整理之前,用一句话说明问题。比起“配置记录”这样宽泛的标题,“如何给一组照片统一命名”更容易让未来的自己找到它。

正文的第一段可以交代适用条件:在哪种环境下操作、输入是什么、希望得到什么结果。不必把所有背景都写进来,只留下影响理解的部分。

一个够用的骨架

对于方法类笔记,问题、步骤、检查三个部分通常已经够用:

# 一个具体的问题

## 前提
需要准备什么,适用于什么情况。

## 步骤
按实际执行顺序记录。

## 检查
如何确认结果符合预期。

如果内容只是一个小技巧,也不必硬拆成多个层级。两个段落配一个例子,可能比六个空标题更清楚。

让例子能独立阅读

代码块前说明用途,代码块后说明预期结果。路径、参数和输出中的占位内容要写得明显,避免把示例误当成可以原样执行的命令。

留一个结束的标准

笔记最后写下检查方法,比单纯写“完成”更有用。检查可以很简单:文件是否生成、内容是否正确、结果是否能再次复现。

先让笔记对未来的自己有用,再考虑它是否足够漂亮。