社区文档撰写指南6.1. 文章开头怎么写？
每篇文章开头都必须有『简介』这个区块。
『简介』相当于是文章的地图，文章一开始的时候，我们先带读者看下地图，让他有一个大体的概念、给予他们正确的方向感，然后再带着他们一步步深入学习。
没有简介的教程文章，会导致读者迷失、体验下降、甚至丢失学习的信心，因此我们强制要求在每篇非『小结』的文章开头，都必须有『简介』区块。
下面讲解一个例子：
讲到异常时，一上来就是很直接的具体操作，有时候会让读者无所适从，如：
但是加上这一段，就会感觉温和很多：
一般简介的撰写思路是：
- 说明这篇文章里，我们要干嘛？简单介绍即可；
- 说明这篇文章里要做的事情，在整个课程或者项目里有什么作用？
- 分享一些开发的经验；
- 学习建议和指引。
以上只是提供一些思路，具体作者们可以自由发挥。只需遵照撰写『简介』的初衷即可 —— 为用户提供一张小地图，防止他迷路。
关于 LearnKu
粤公网安备 44030502004330号