我們想要表達一件事物時,會受限於自己的知識水平。知識水平低會帶來問題 —— 表達不夠正確,語焉不詳可以使得表達不出錯,許多人會以此手段規避錯誤。知識水平高也會帶來問題 —— 處處是術語讓外行人聽不懂,相關的知識不一定在讀者的腦中,這會讓尋常人難以讀懂表達。
所有的表達都有其受眾。哪怕簡單的文字,也需要受眾識字且有基礎的閱讀能力;牙牙學語的小朋友只能接受繪本的表達。我們寫作的受眾是誰?技術文章是給比作者水平更高的人看嗎?
知乎#
今天逛知乎看到一個問題 給孩子講題為什麼容易急眼? - 知乎。
因為你說話喜歡用超鏈接,你心裡有一個庫,信息都是從庫裡調用的,但孩子沒有這個庫,你一堆超鏈接發過去全調用失敗,你說半天孩子那聽到的都是 404 not found。
文字、語言本身就是一種超鏈接,至少需要讀者能理解詞語的意思,比如 == 超鏈接 == 就是一個不那麼常見的詞。但是我們又不可能長篇大論在這裡插入 == 超鏈接 == 的詳細解釋。那么這篇文章的受眾就具備起碼的上網衝浪經驗,這些我們眼中的常見詞彙不必詳細解釋。
避免出現文章讀一半覺得看不懂、讀一半覺得囉嗦沒意義,寫作前評判文章的受眾具備怎樣的知識是有必要的。
我的寫作#
現在看來,我的技術博文往往假設讀者是某個技術領域的初學者,大部分博文都是手把手教程,一步一步點擊總能看到預想的現象。在沒有方法論支持的時候,我已經無意識地注重讀者的水平問題了。 驕傲 (‾◡◝)
但是仍然有稍微深入一些的博文,是需要讀者具備1水平,就需要大量讀者所不具備的前置知識,但又沒有相關說明,讀者又會四處查找雜亂的資料。
傲慢和懶惰#
書本文字受限於篇幅,往往整本書只能著重解決一個問題,而且前置技術都一筆帶過。
我認為好的文章是一站式解決方案,如果這個問題是2級別,那麼未入門~心轉手的讀者都應該通過一篇文章解決問題。
得益於軟件形式的呈現,一篇文章可以專注描述整體流程,其中的前置知識和細節可以以超鏈接形式插在某些段落。
寫這樣一篇好的文章費時費力,而且沒什麼收益,我也沒法真正嚴格以此要求自己。
但我認為這樣的終極標準是沒問題的。不這樣做就像寫作代碼不寫註釋,如果看代碼的人能無障礙輕鬆讀懂,那讀者的水平可比寫作者高很多。
對於技術寫作,我不認為 "像詩一樣" 是好的評價,詩是簡潔有力的文化超鏈接,詩的解釋千人千面,詩的內涵豐富複雜。但對技術,我的要求是盡可能精確的描述,只有通過無數精確的部件,才能拼湊一個精確的技術系統,最好不要有爭議和副作用讓人撓頭。
笨寫作#
把自己當作笨笨的作者,毫不留情地榨取自己。
把讀者當作笨笨的讀者,寫出猴子能看懂的莎士比亞。
此文由 Mix Space 同步更新至 xLog 原始鏈接為 https://www.yono233.cn/posts/white/25_4_3_BungleW