如何为开源项目和社区做贡献 -- 你应该知道的十件事（五）——如何为开源项目写技术博客？

4. 如何推广自己的项目

? 前面我们已经讲了如何创建自己的项目，但是，项目创建好了如果不进行推广将会很难获得大家的关注，如果长时间没人关注，也会影响开发的动力，因此，当项目做好后，一定要做好项目的推广工作，一方面可以让更多的人看到我们的工作，给有需求的提供找到我们的机会，也另一方面有助于提升自己的知名度。下面我将从以下几个方面向大家介绍如何推广自己的项目。

问题六：如何为开源项目写技术博客？

? 给自己的开源项目配备相应的技术博客是很有必要的，这也是宣传和推广我们的项目最直接和最有效的手段；而且作为我们做开源的程序员，也一定要有自己的博客，方便展示和推广自己项目工作以及增加自己的知名度。
首先是博客平台的选择，目前国内博客平台也是比较多的，比如博客园、CSDN、沙土掘金、简书等，大家可以根据自己的情况进行选择。但是选这一个即可，无需多选，但是如果你觉得比较重要的文章，你可以在多个平台上发布，让更多人看到。当前国内用的比较多的是CSDN平台，虽然该平台被大家诟病很厉害，但是不可否认的是该平台用户量大，而且我们遇到问题是，使用CSDN也是最多的。大家可以根据自己情况进行选择，无论在哪个平台，只要你把文章写好，在哪里都能被大家看到。

? 下面就是文章的撰写，其实在项目做完后，撰写个对应的技术博客还是比较简单的，毕竟博客大部分内容都是对你项目的介绍内容，因此针对你所做的项目，你应该会有说不完的话。但是，为了写好这个技术博客，你还是要注意一些问题的。

1. 文章标题

? 首先第一点主义的是是文章标题，技术博客跟文章不同，文章的话标题可能还需要新意、修辞等，技术博客不需要考虑那么多事情。技术博客标题第一点要注意的就是简单、直接，能够准确描述博客的主题，让人看了一目了然，因为大家在看技术博客时，第一眼印象就是对你博客标题印象，因此要起一个简单直接的标题。第二点就是题目中要有主要的关键字，关键字可以是使用的主要技术、解决问题主要内容等，一方面是因为关键字可以快速吸引更多的读者观看，另一方面就是包含关键字更容易被检索出来。

2. 文章的层次

? 接下来第二点在需要注意的是文章的层次，不同类型的技术博客文章的层次应该是不同的。此处我以常见大项目技术博客为例，给大家简单介绍一下博客的结构层次。

• （1） 引言
  ? 引言部分类似于文章的摘要，要包含本项目的背景、介绍以及实现功能，能然人一眼看出你的项目有什么作用，这样才会吸引读者认真读下去。之一部分放在文章开头，可以不占用文章的章节编排。其实你平时在找相关项目时，发现题目可能相关，但是他没有一个简单的介绍，内容还比较长，你就会很难有耐心读下去，因此，有一个简单的引言是很有必要的。
  ? 另外在引言最后，一定要添加你的项目源码链接、视频链接等其他相关材料的链接，能然读者看出你这文章内容很全面，更加坚定读者读下去的信心。

• （2） 现状与技术介绍
  ? 接下来就是你技术博客的正文部分，这一部分可以有很多内容可写，例如详细介绍以下你的项目背景、详细介绍一下你项目中所使用的技术手段以及本项目的实现原理等。这一块内容根据你自己的安排去写即可。

• （3） 环境配置与项目安装
  ? 这一块内容主要分为两个方面，第一就是你项目所使用的环境配置流程以及你的项目安装配置流程。这一块是十分关键的，因为对于大多数人可能不太会关注你的项目源码，他就只会参考着你的博客进行实现，因此在写这一块时，要把自己当作一个使用者，自己如何从头开始一步步安装和配置该项目，并且对于每一步要有截图，这样才能更好的让使用者成功复现。

• （4） 项目关键内容讲解
  ? 下面这一块是对自己项目内容关键代码讲解，对于一个项目来说，项目代码可能会很多，因此无法在博客中做详细解释，因此在此处只需要对自己项目中的一些代码的关键部分进行解释就可以。重点是你所解决的问题那一块代码，或者是某项技术的应用代码，对这一块代码做一个简单讲解即可，也无需长篇大论，重点是让对着看到你这一块代码的重要性。

• （5） 项目结果展示与性能分析
  ? 上面介绍完项目内容后，接下来就是演示一下项目效果，此处最好是通过图片、视频等方式进行展示，当然使用文字也是可以的。这一块主要就是演示一下你的项目输出，方便读者查看你的项目输出效果是否达到他的预期。另外，如果你做的项目是对前人的项目优化或者是该项目高喊多个影响因素等内容，那你此处就需要做以下对比，对比一下常见的指标即可。

（6） 总结
? 最后一步就是对自己的项目做一个总结，简单总结一下项目，可以对恶化也可以说一下自己项目的问题以及下一步要改进的地方等等，或者是感谢一下该项目中给你童工版主的人，最后增加一句感谢读者的话或这是对读者期待的话进行文章收尾。

3. 博客的代码

? 第三点需要注意的是博客的代码。在博客里面，我们难免要放一些代码，这也是写博客的一个很好的习惯。但是在放置代码时，一定不要直接复制全部的代码放进去，首先是要放一些关键的代码，例如项目中比较有创新的代码或者是某个关键技术应用的代码；第二点就是要注意代码的格式是否美观，我们在编辑器开发代码时，编辑器会根据代码特点增加不同颜色，因此在博客中我们也要遵循这种特色。想要实现这种方式也不难，因为现在一些博客使用的是Markdown语法编辑器，你可以通过设置成程序语言即可；如果你对该配色方案不满意，也可以通过一些其他的插件生成图片。

4. 文章排版

? 第四点就是要注意文章排版，让自己的文章变得更优美。前面我们已经提到博客现在多数使用的是Markdown语法，你需要学习一下该语法下文章排版的技巧，例如如何首行缩进、如何添加代码、如何改变文本颜色等等。此处也不用学的太深入，只要学习一些简单的语法即可，后续慢慢积累并养成习惯，你会发现自己的文章会越来越整齐美观。
最后一点就是礼貌，注重自己的语言艺术，不要使用一些过激的语言，对待别人的项目也要做到尊重。