技术博客写作指南

技术博客写作指南

一、博客内容

1.学习框架

学习框架的内容，粗浅分为某职业学习路线和某类技术学习内容。

（1）某职业学习路线

用于介绍，在某类职业实际工作和项目设计中，所需要的技能，技能学习的顺序以及相应的时间安排。

介绍的内容可以包含介绍职业涉及领域，对于职业中会涉及到的知识进行说明分享；技能的学习顺序，在职业涉及较多的领域时，其中包含的知识点杂乱繁多，整理学习的顺序和逻辑进行分享，按照学习难易度，或项目规划学习；还可以针对知识给出大致的时间安排，以及学习程度等给出分析。

例如，知乎大神写的机器人工程大学学习路线规划：

（2）某类技术的学习内容

针对某类技术或软件的学习重点或难点，需要掌握的学习的内容整理。类似于项目的实现步骤，可以根据完成项目的技术要点，侧重学习，获得更多正反馈，增加学习兴趣。

例如前端框架实战学习内容：

2.技术点

（1）项目关键点

在使用开源项目时，在实现项目的过程中，对项目的关键点进行分析，并给出处理方式等。在实现复杂开源项目时，常常需要粗略理解项目包含的模块和相应功能，在实现项目的过程中，针对个人需求更改项目源码时，其中的关键函数、关键方法进行记录，便于重现。

例如，YOLOv5 自定义数据集方法整理：

（2）DeBug

开发或使用开源项目时，无可避免的会遇到 Bug，当解决 Bug 之后，进行记录，整理形成 DeBug list 对于之后的项目的实现留下参考。

3.学习方法和资源分享

学习方法和资源分享，分享学习技能时，所采用的方式并分享在学习过程中，自己所采用的方式的资源资料，提供参考。以项目为导向的学习，先找到实现项目的技术点，针对性学习其中的技术，复现项目进行学习，提供项目源码或项目地址；以书籍、视频为学习方式，给出书籍和视频的学习顺序，提供网址和书籍文件。

也可以针对在项目中所采用的软件的用途和优势，进行说明和介绍。

二、博客结构

1.标题

应该做到两个要点，标题简短不冗长、清晰表明作用目的。除两个要点之外，还可以加入项目所具有的特点。

2.导语

包含目录/整体大纲（思维导图），目录大多针对于博客内容中的技术点、学习方法和资源分享的逻辑整理；整体大纲（思维导图）常用于学习框架的整理。目录和整体大纲（思维导图）不仅能给出更清晰的逻辑，也便于在搜索时，更快的找到所需的位置。

3.主体内容

• 条理清晰

依照目录或整体大纲（思维导图），进行主体内容的写作。

• 内容易懂

避免使用较多的专有名词，那会使得内容的可读性降低。

• 引用博客

当引用他人博客时，贴上相应的网址，便于他人查看详情。

• 图文并茂

一定要避免通篇的长文以及全是文字的文章，图文并茂的写法，会增加阅读兴趣。

• 注明项目软硬件版本型号

相同项目中，会由于软硬件版本型号的区别，而无法实现，注明实现相应的软硬件版本型号，便于复现。

例如，江大白深入浅出 Yolo 系列：