App下載

如何寫技術文章?

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

本文將從準備工作、文章結(jié)構、注意事項等方面展開,希望對樂于分享的同學有一定啟發(fā)。

準備工作

動手寫文章前,須依次明確兩點:目標受眾;寫作思路。

明確目標受眾

誰會看我們的文章?
誰會對我們的文章感興趣?

這是撰寫文章的首要問題。

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

梳理寫作思路

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

img

再經(jīng)幾番調(diào)整,文章的基本框架便有了,可以開始撰寫初稿。當然,這個基本框架也會隨著寫作的推進不斷動態(tài)調(diào)整。

曲線辦法

另外,這里提供一個曲線解決問題的懶人思路。該思路來源于各類技術大會實錄。

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

寫作時,只當自己在面對觀眾做現(xiàn)場 presentation,將要說的話適當潤色,插入到每張 ppt 前后。注意配以適當?shù)霓D(zhuǎn)折語句。

這樣的好處有三:圖文并茂,適合閱讀;信息密度較純文字高;傳達文字不足以完成的信息。

文章結(jié)構

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

“起”

忘了是誰說的,好的開頭是成功的一半。

一般來說,在文章開頭,你需要交代寫作緣起,如業(yè)務遭遇痛點、線上神秘 bug 等。

而后,簡要介紹文章將從哪些方面展開、達到什么目的,而讀者能從中獲得何種收獲。

“承”

承接開頭,開始按事先整理的大綱,切入正題。可以開始詳細介紹相關場景、探索解決方案的歷程。

需要注意的是,始終不能忘記目標受眾。根據(jù)目標受眾特點,注意在必要的地方,提供必要的背景知識,如某項技術的發(fā)展歷史及相關術語介紹。

“轉(zhuǎn)”

經(jīng)過前面的充分鋪墊,話題轉(zhuǎn)入突破階段??梢栽敿毥榻B你所尋找到的突破方案及其效果。如有多種方案,建議同時列出,并加以對比。

“合”

回顧全文,適當總結(jié):

  • 文章解決了什么問題?
  • 還可以進行哪些方向的探索?
  • 有何不足之處?
  • 展望未來

注意事項

在寫作過程中,有一些細節(jié)需要注意。

切忌以下問題 ——

  • 羅列大量術語:全無背景介紹,直接開始羅列一堆概念
  • 粘貼長篇代碼:大篇幅引用代碼,影響閱讀體驗
  • 風格變化無常:時而嚴肅、學術風,時而賣萌、抖機靈
  • 內(nèi)容貪圖簡便:使用代碼塊、圖片或 blockquote 完全取代正文

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

總結(jié)

以上談了一些技術文章寫作的套路,但更重要的還是日常積累。

當然,日常學習時也要有所甄別,擁抱精品,遠離次品。

相關閱讀:

作者:文藺 來源:奇舞團(75.team)

0 人點贊