记录一些博客写作心得

摘要

本文主要讲述一些平时写作过程中和查询资料时遇到的问题，整理出来并加上个人见解，供大家交流分享。

---

关于教程示例

1. 教学是否有价值？

一篇优秀的教学文章，不要求读者在阅读理解了文章内容后，能完完整整实现文中所述的整个内容，但至少能实现其中讲述的核心模块。否则这篇文章就没起到作用，不会的还是不会。

---

2. 读者是否能读懂？

如果有一些对学习阶段的读者不太友好的专有名字或生僻词汇，请至少给出一个说明或链接提示读者去查阅相关信息。文章言辞上应该尽量通俗易懂，内容上应该具有逻辑连贯性，尽可能给读者铺路，去引导他们，而不是给读者挖坑，去刁难他们。

---

3. 引用是否权威？

引用官方资源的文章，请在必要位置给出内容来源或者参考文献等，不仅是作为一项依据，提高内容来源的权威性和真实可靠性，也是给读者提供一个扩展学习的机会。

---

4. 文章是否严谨？

对于文中来自作者个人的内容，请确保其相对正确性，在作者自身都不确定代码是否能运行或者结论是否正确等情况下，请不要以肯定的语气写下，否则可能会对读者造成误导。

---

5. 隐患是否告知？

对于读者在按照教学一步一步实现的过程中，或者作者过去在实现的过程中，遇到的一些隐患问题和很难解决的bug，应该显式地在文中说明可能会出现的问题以及引导读者去解决问题，而不是让读者止步于此。

---

6. 是否有实例参考？

教学文章很忌讳通篇都是文字或大段大段的代码，那会让读者觉得枯燥无味，不利于学习。无论是代码段，还是贴图，甚至可以是gif图，演示视频，实时预览效果，在线demo等，都是有利于提高读者兴趣阅读文章的。

---

关于解决方案

1. 能否解决问题？

一篇解答类文章，应该针对某一个问题，或某一类有相同特征和相似解法的问题，起到对症下药的作用，如果是不同领域的问题，作者应该先自己实践，确定方法可行后，再讲述自己的解答过程，并加以讲解原理。

2. 描述是否有代表性？

对于标题包括问题日志的，如果信息很长，应该截取其中的关键语句，省略与问题无直接关系的提示语句，如果信息很短，应该保留完整信息，供读者对比参考。
对于摘要或者正文才描述问题日志的，请提供问题原始日志，可将敏感信息用符号替换，这样便于读者确定是否是他搜寻的问题。

---

3. 是否给出产生原因？

解答的文章，不仅应该解决问题，还应该分析总结为什么会出现这个问题，知其然并知其所以然，这样才可以避免下一次出现同样的问题，同时，能分析出产生原因，更能够帮助读者加深记忆，扩展知识面。

---

关于学习笔记

1. 分类是否清晰？

笔记类文章，应该明确细分属于哪一类知识点，记录关键词，这样便于将来自己回顾时快速理解，也利于读者明确相关知识体系。

---

关于版权

1. 是否属于转载？

对于转载的文章，应该在明显的地方注明文章来源以及原著链接等信息，尊重每一位作者的劳动果实和知识产权。

---

2. 是否有引用？

同转载，引用部分也应该说明引用自哪位作者的哪一个作品。

---

总结

坚持写博客是一个好习惯，但写出来的博客要优雅美观，而不是草草了事只图篇数。一篇优秀的博客，不仅是作者技术水平的体现，也是作者职业素养的侧映。