一份以后还能看懂的技术笔记

除了最终答案,记下问题为什么出现,以及自己为什么选择这个解法。

本文为 mieka 博客的原创示例内容,可替换为自己的文章。

只记结论的笔记,在当下很简洁,几个月后却可能变成一道新的谜题。多留一点上下文,往往能省下下一次排查的时间。

先写清问题

记录预期行为、实际行为和复现条件。它们是理解后面所有尝试的起点。

保留关键的取舍

不必把每一次尝试都流水账式地记下。挑出影响最终选择的证据,解释为什么这个方案适合当前条件。

给未来的自己一条入口

附上相关文档链接、可运行的小例子和适用范围。笔记不是考试答案,它更像下一次工作时可以继续展开的地图。

深色模式,应该由读者决定
桌面留白,思路也跟着清楚一点