如何寫(xiě)技術(shù)文章？

猿友 2020-10-21 15:15:44 瀏覽數(shù) (3961)

反饋

本文將從準(zhǔn)備工作、文章結(jié)構(gòu)、注意事項(xiàng)等方面展開(kāi)，希望對(duì)樂(lè)于分享的同學(xué)有一定啟發(fā)。

準(zhǔn)備工作

動(dòng)手寫(xiě)文章前，須依次明確兩點(diǎn)：目標(biāo)受眾；寫(xiě)作思路。

明確目標(biāo)受眾

誰(shuí)會(huì)看我們的文章？
誰(shuí)會(huì)對(duì)我們的文章感興趣？

這是撰寫(xiě)文章的首要問(wèn)題。

動(dòng)手前，一定要先想好你的目標(biāo)受眾，即文章面向哪些讀者。要充分考慮讀者的背景。面向的讀者不同，語(yǔ)言風(fēng)格、展現(xiàn)形式等也須有所不同。以技術(shù)科普文章為例，你需要提供充足的背景知識(shí)，通過(guò)場(chǎng)景化、故事性的方式切入主題，并提供一系列簡(jiǎn)單、可復(fù)現(xiàn)的示例。

梳理寫(xiě)作思路

明確受眾之后，可以用某種結(jié)構(gòu)化的形式梳理寫(xiě)作思路，如帶有層級(jí)的列表、思維導(dǎo)圖等。如下圖所示，正式寫(xiě)作本文前，我使用 markdown 梳理了本文寫(xiě)作的大致思路。

再經(jīng)幾番調(diào)整，文章的基本框架便有了，可以開(kāi)始撰寫(xiě)初稿。當(dāng)然，這個(gè)基本框架也會(huì)隨著寫(xiě)作的推進(jìn)不斷動(dòng)態(tài)調(diào)整。

曲線辦法

另外，這里提供一個(gè)曲線解決問(wèn)題的懶人思路。該思路來(lái)源于各類(lèi)技術(shù)大會(huì)實(shí)錄。

寫(xiě)文章前，你也可以先做一份 ppt（結(jié)構(gòu)清晰、內(nèi)容精美者為佳），并將 ppt 轉(zhuǎn)換為圖片逐次放入文稿中。

寫(xiě)作時(shí)，只當(dāng)自己在面對(duì)觀眾做現(xiàn)場(chǎng) presentation，將要說(shuō)的話適當(dāng)潤(rùn)色，插入到每張 ppt 前后。注意配以適當(dāng)?shù)霓D(zhuǎn)折語(yǔ)句。

這樣的好處有三：圖文并茂，適合閱讀；信息密度較純文字高；傳達(dá)文字不足以完成的信息。

文章結(jié)構(gòu)

優(yōu)秀文章套路基本相似，問(wèn)題文章則各有各的缺點(diǎn)。這里我用“起承轉(zhuǎn)合”四字來(lái)概括基本套路。

“起”

忘了是誰(shuí)說(shuō)的，好的開(kāi)頭是成功的一半。

一般來(lái)說(shuō)，在文章開(kāi)頭，你需要交代寫(xiě)作緣起，如業(yè)務(wù)遭遇痛點(diǎn)、線上神秘 bug 等。

而后，簡(jiǎn)要介紹文章將從哪些方面展開(kāi)、達(dá)到什么目的，而讀者能從中獲得何種收獲。

“承”

承接開(kāi)頭，開(kāi)始按事先整理的大綱，切入正題。可以開(kāi)始詳細(xì)介紹相關(guān)場(chǎng)景、探索解決方案的歷程。

需要注意的是，始終不能忘記目標(biāo)受眾。根據(jù)目標(biāo)受眾特點(diǎn)，注意在必要的地方，提供必要的背景知識(shí)，如某項(xiàng)技術(shù)的發(fā)展歷史及相關(guān)術(shù)語(yǔ)介紹。

“轉(zhuǎn)”

經(jīng)過(guò)前面的充分鋪墊，話題轉(zhuǎn)入突破階段?？梢栽敿?xì)介紹你所尋找到的突破方案及其效果。如有多種方案，建議同時(shí)列出，并加以對(duì)比。

“合”

回顧全文，適當(dāng)總結(jié)：

文章解決了什么問(wèn)題？
還可以進(jìn)行哪些方向的探索？
有何不足之處？
展望未來(lái)

注意事項(xiàng)

在寫(xiě)作過(guò)程中，有一些細(xì)節(jié)需要注意。

切忌以下問(wèn)題 ——

羅列大量術(shù)語(yǔ)：全無(wú)背景介紹，直接開(kāi)始羅列一堆概念
粘貼長(zhǎng)篇代碼：大篇幅引用代碼，影響閱讀體驗(yàn)
風(fēng)格變化無(wú)常：時(shí)而嚴(yán)肅、學(xué)術(shù)風(fēng)，時(shí)而賣(mài)萌、抖機(jī)靈
內(nèi)容貪圖簡(jiǎn)便：使用代碼塊、圖片或 blockquote 完全取代正文

有以上問(wèn)題且難以克服者，建議使用前述“曲線辦法”，可能一定效果。

總結(jié)

以上談了一些技術(shù)文章寫(xiě)作的套路，但更重要的還是日常積累。

當(dāng)然，日常學(xué)習(xí)時(shí)也要有所甄別，擁抱精品，遠(yuǎn)離次品。

如何寫(xiě)技術(shù)文章？