写技术博客的注意事项

我的认为写博客（Blogging）是技术总结的最佳方式，甚至能够这样子讲，博客就是积累，从必定角度上讲是酱紫的。多是受规范约束习惯了，感受写博客也有一些注意事项，虽然以前写了不少文章，但感受都不是很规范，现总结写博客应该注意的几点，以随时提醒本身。

1. Do not Repeat Documents, link to it   不要重复文档，给出连接就好。重点写本身的心得，体会和总结。

对于那些在官方文档中都讲的很清楚的东西就没有必要再进行重复了，给出相应的连接就行了。特别是对于像MSDN这种很是丰富的官方文档，最好不要去重复它的内容，由于你不必定比官方讲的清楚。重点应该放在本身的心得，体会和总结等，这样于本身是真正的总结和积累，能变成经验，于他人也是一种有价值的参考的。

2. 进行全面的总结

前面说了不要重复文档，那应该写什么呢？愚认为，应该是本身通过实践以后的总结：

• 把全部可靠的方法都说一下;

• 把注意事项说一下;

• 把各类方法进行比较，给出各自的优缺点和适用场合;

• 文档中没有说明的状况，好比对文档的补充，或者文档有自相矛盾的地方。

3. 必须亲自实践进行验证，确保可靠可行。并附上实例（源码，资源）和运行结果（截图等）

4. 要总结与所谈内容相关且有价值的网络资料

5. 要列出参考资料，好比官方文档，别人的博客，源码等。这是对别人的尊重，也是对知识的一种尊重。

6. 能够参考，能够引用，但不要照搬，不思考式的抄袭。最重要的是要有本身的思考和理解。

若是是受他人的博客或代码的启发，最好把关键的句子段落引用出来，而后再写本身的思考和讨论。在文章中再给出原文或出处的连接，这样以显得尊重和专业。

7. 最好能有版本控制信息和修订记录

对于代码咱们都有版本控制系统来帮助维护修改记录。但对于文档，也建议这样作。对于博客，可能没有（或许我不知道）相似的工具，但能够手动来讲明。好比在博客的头部或尾部加上修订历史记录，或者在文章中把后来的修改用其余字体标明，或者用括号或脚注来讲明。这样自已往后看起来也很方便，也能看到本身的思考过程和成长过程。

8. Less But Better精深原则

讲的越详细越好，范围越小越好，但要深刻的讲，正如那句话，十个百分之十不如一个百分之百。若是你不能深刻的讲，证实你尚未到写的时候，应试再去学习或者实践，直到你能讲的很清楚，讲的很详细，讲的很深刻的时候再来总结和写博客。争取作到一篇文章一个点，这样文章多了就成了网最后变成没有漏洞的面。

9. 突出主题，分清主次，逻辑清楚，井井有条

这多是对于写做的通用要求，提及来容易，可是作起来就比较困难。其实也不难，主要表如今：

• 列表来罗列要讲的东西
• 用标题先简明归纳，而后再详细讲解
• 标题与正文用不一样的字体样式标识
• 用字体和缩进来标识标题和正文

有没有一种感受，这好像是在讲编码规范，没错，很早就有人讲过，写文章跟写代码是同样的。因此，做为程序员的咱们，能够考虑用写代码的一切，包括习惯，规范来写文章。

10. 写完后多读几遍，进行校改

这就比如写完代码后的调试与测试。好代码是改出来的，好文章也是如此。可以一蹴而就的人有，但不多。即便是像鲁迅那样的大做家写文章都还须要修改，都没有一次成型的，更况且咱们呢？在写完文章后也视状况对文章进行调试和重构，直到本身读起来感到满意和舒服为止。试想，若是本身写的文章自已都不想看，别人会看吗？咱们又不是在写做业，无论好坏老师总会看，并且要仔细的看。要想写出好文章，必须首先让本身认为是好文章。

11. 用通俗易懂的平实的语言，对于专业术语要解释

好的技术文章应该都很是容易看懂，即便你对所说的那门科学彻底不知。去读一读《Code Complete》等之类的经典书籍的英文原版，你会发现，其实看原版书并不须要多么NB的英语水平，能够不客气的讲上过大学的人应该都能看懂。其实这重点不在你懂不懂英语，而是要看做者可否用最易懂的语言来把事情表达清楚。这确实是一种能力，日常咱们所谓的沟通能力，也基本上就在这，看你可否用最简单的语言把事情表达清楚，让另外一方听明白。

这里有一些技巧：

• 多用比喻，用你们熟悉的东西来比喻，这是让人最容易理解的一种方式。好比把软件构建比做建房子;把软件架构师比做楼房的设计师等。
• 多用图示，用图解。不少时候一张图能抵上几百字的文字叙述，但还不必定能说明白。给出一张图就什么都明明白白了。
• 图文并茂是讲解的最佳方式，合理的安排图片，再加之文字描述会达到事半功倍的效果。

12. 用事实说话

有图有真相，有代码有真相。说完了，讲过了，最好附上真实事例，代码和截图。不然别人可能会质疑，至少我在看到别人只“说”，没“作”的时候会质疑的。