文章開頭怎么寫?
每篇文章開頭都必須有『簡介』這個區塊。
『簡介』相當于是文章的地圖,文章一開始的時候,我們先帶讀者看下地圖,讓他有一個大體的概念、給予他們正確的方向感,然后再帶著他們一步步深入學習。
沒有簡介的教程文章,會導致讀者迷失、體驗下降、甚至丟失學習的信心,因此我們強制要求在每篇非『小結』的文章開頭,都必須有『簡介』區塊。
下面講解一個例子:
講到異常時,一上來就是很直接的具體操作,有時候會讓讀者無所適從,如:

但是加上這一段,就會感覺溫和很多:

一般簡介的撰寫思路是:
- 說明這篇文章里,我們要干嘛?簡單介紹即可;
- 說明這篇文章里要做的事情,在整個課程或者項目里有什么作用?
- 分享一些開發的經驗;
- 學習建議和指引。
以上只是提供一些思路,具體作者們可以自由發揮。只需遵照撰寫『簡介』的初衷即可 —— 為用戶提供一張小地圖,防止他迷路。
社區文檔撰寫指南