如何写好一篇技术笔记？
兄弟们好，我是寅贝勒
最近在公司内除了正常开发业务需求外，还在参与一些技术文章沉淀的工作，会去组织分享一些中间件的技术知识分享，这种分享不需要精美的ppt，更多的是一篇飞书文档，那么如何让大家快速定位到你要分享的内容就显得尤为关键，除了要有明显的标题之外，还需要有一个相对明确的框架。
今天就来和大家分享几个我一直常用的行文框架，希望能够帮助到写文章的新手，帮大家快速完成一篇70分以上的技术文章。
首先第一点，就是要明确写作的好处，对于程序员来讲，一方面可以沉淀下来自己学过的知识，方便日后查阅和快速上手；另一方面把文章发到公域，会给自己带来一定的技术影响力，同时也可以锻炼自己的书面表达能力。
记得我第一次写博客是在大二的时候，第一次完成了一个JSP的初创项目并且把它部署到了自己的服务器上，申请了域名，成功访问。把整个流程梳理下来发到了csdn上，当时有非常多的浏览和点赞，那个时候虚荣心得到了比较大的满足，之后每解决一个问题就要想发博客的冲动。
其实上面说的那篇文章就对应 第一个模板：操作手册类文章
这种文章主要在于把自己整个操作流程完整记录下来，帮助大家规避一些雷区。
这种文章的应用场景主要是针对某个操作的具体指导，例如学习如何配置某个平台，通过某个操作可以实现某个功能等等。行文可以主要分为这么几个大块：
- 背景：哪些场景下会需要这个操作，这项操作具有哪些优势，完成操作需要多长时间
- 准备工作：完成这项操作需要提前准备什么系统，安装什么软件，开通什么权限等等
- 操作流程：完成准备操作之后，最好先大致罗列一下需要哪些步骤，步骤之间的依赖关系，必要时候配合图片说明，然后按照具体步骤进行撰写，每一步都进行截图，同时通过文字介绍具体的操作是什么，产生什么样的结果，需要注意的点有哪些，注意避坑。如果整个操作是连贯的，能够直接进行到结尾，在撰写时每一步无需单独设置标题格式。如果操作时分散的，分为好多个部分，可以每个部分单独设置一个标题去撰写。
- 参考引用：在此可以列出更多和该操作相关的文章以及参考的文章，例如技术介绍、扩展阅读等等。
第二个常用模板：针对某个技术点的分享
这类模板的应用背景主要是针对某个技术点进行了研究，例如介绍某个原理、某个机制是什么，着重讲解原理，而不涉及太多的实践，这类文章一般要配合思维导图等工具，旨在将复杂的东西简单直白的讲明白。
这种文章主要分为几个模块
- 背景：这项技术出现的时间，是为了解决什么问题而产生的，这项技术的发展历史，目前有什么应用，本文主要讲解其中哪些部分，了解这些有什么好处。
- 相关概念：如果全文中会有一些高频概念，或者了解该技术需要一些前置的基础知识，可以在此部分进行介绍。
- 技术详解：这里主要是用图的形式来具体介绍，思维导图、流程图、时序图、ER图，配合逻辑清楚严谨的文字来进行讲解，可以贴上代码辅助理解，如果涉及多个知识点，可以在这里以格式复制的形式写多个段落。
- 总结：你对该技术的一些判断，学习/使用该技术有什么需要注意的点，哪类的产品/场景适合使用这种技术。你是否有应用过，结果如何。
- 参考引用：列出学习这些知识点的过程中看过的文档以及其他扩展阅读的文档。
第三个常用模板：Bug分析类内容
这类模板的应用背景对于我们来说比较日常，你只要写代码就会出错，不想错最好的办法就是不写哈哈。如果遇到了bug，解决了就过去非常容易遗忘，最好的方式还是快速记录下来，以供日后查阅，沉淀思路的同时给其他遇到同类问题的人以参考，文章大多以第一人称视角书写。
这类文章主要分为：
- 问题背景：主要介绍什么背景下，遇到了什么问题，展示一下报错信息。经过多久的处理，目前是否从根本上解决，这个问题最值得分享的点是什么，本文主要分享该问题的追查过程还是解决思路。
- 问题分析：主要介绍排查过程，如果是公司里的线上问题，一定要先修复止损，这个优先级很关键。遇到问题后做了什么，一般是怎么处理的，每一步处理后的结果是什么，最后排查到具体是哪里出了问题。
- 处理过程：定位问题后是如何解决的，解决后是否恢复了正常，是否有相关的验证，是否从根本上解决了问题，如有相关数据可展示。
- 总结：为了避免遇到此类问题，反推一下在编写代码、写单测的过程中有哪些需要注意的点。有哪些手段可以高效排查问题，此类Bug一般是什么问题导致的，在处理问题的过程中学会了哪些新的知识点。
好啦，今天先介绍这三种常用的笔记框架，希望对大家有帮助，最最重要的是快快记录起来
