聊聊技術寫作的個人體會

有群友問過，是什么原因使我開始寫技術公眾號，又是什么動力讓我堅持寫的。

在我看來，寫作是一件不能敷衍的事，通過寫作來學習，反而要比單純地學習的效果要好。為了寫成一篇“拿得出手”的文章，我要反復查找資料，閱讀與思考，拆解與整合，最終寫成的時候，也是知識的拼圖成型的時候。

所以，對我來說，**寫作是一種咀嚼信息而后提煉知識，最終拓展成技能與認知的過程。**雖然這個過程很緩慢，但曾經的急進方式并沒有速成的效果啊，不妨就這樣一文章一腳印地試試看咯。

除此之外，還有一個很重要的原因。文章是一種公共對話的媒介，它是一個展示的窗口，也是一個接收反饋的通道。通過寫作，我有了跟其它學習者對話的機會。

看書學習可能只是個人的事情，但是，在寫作平臺上發布文章，這就超越了個人行為——你得隨時準備著被批評、或者被請教、或者被誤解、甚至是被無視（這是最常見的結果）。

我享受寫作文章，來跟其他處在相同處境的同學們交流，來向更優秀的大牛們學習取經。

這就是我目前寫技術文章的一些個人體會吧。

對于上面提到的第二個原因，我最近頗有感觸，想要多聊一些。為了更有針對性，本文姑且限定一個話題吧，那就是“寫作技術文章，如何看待他人的批評/意見”。

1、主觀性的意見

有些聲音其實只是主觀看法，我認為可以和而不同。

主觀世界往往沒有確切的對錯之分，畢竟——思想無罪 。

面對主觀性的意見，我認為要做到有理有據，堅持一點個性，最后會得到別人的尊重。

比如，在翻譯 Python 社區的七種治理模式的時候，有一個提案是“Python Governance Model Lead by Trio of Pythonistas”，我將它翻譯成“三巨頭治理模式”。有同學就指出，“Trio”應該翻譯成“三人組”或者“三重奏”，翻譯成“三巨頭”是什么意思？

這種留言，我認為是主觀性的意見，應求同存異。

我之所以這么翻譯，一方面考慮，它要替代的是“終身仁慈獨裁者”，三巨頭對獨裁者，意味深長；另一方面，我腦子里總想著一個皇帝死了，然后政權被三個攝政大臣把持，這種政治畫面揮之不去，雖然是不著邊際，但挺有趣味，所以我不肯放棄這“三巨頭”的譯法。

主觀性的意見帶入了提出者的個人知識背景、思想結構、以及話語習慣等等，我覺得要先嘗試交流，相互交換，能融洽兼容則最好啦，不能的話，及時終止。

2、客觀性的意見

客觀性的意見有如下幾種：筆誤（錯別字和其它疏忽）、代碼規范、知識性錯誤......

對于筆誤性的錯誤，這沒啥好說的，我自己發現過幾處，也被讀者指出過幾處。有則改之就好。

對于代碼規范，有時候為了舉例方便，確實沒有按照規范來。盡量避免，求一個兼顧。

知識性錯誤是要熱烈歡迎的——不是說歡迎錯誤，而是說歡迎別人來指出我所未知的錯誤。

出現知識性的錯誤，就意味著沒有全面掌握知識，一旦出現，就必然意味著有提升的空間。本來以為知道了什么，如果被指出了錯誤，那改正后，才是真的知道了什么。

知道自己不知道并且改正之，并不可恥，不知道自己不知道，這才可憐。

在寫《Python是否支持復制字符串呢？》的時候，我根據已得的知識，以及查閱到的資料，早早就得出了一個很滿意的結論。最后成文前，臨時地加了一個未作驗證的示例，沒想到這會是一個致命的反例，推翻了前面辛辛苦苦建立起來的一切。

這是一個客觀性的錯誤，一被指出的時候，很快就能驗證。因為這個錯誤，我重新梳理了相關的知識點，組成新的知識面，寫成了一篇《join()方法的神奇用處與Intern機制的軟肋》。

還有一個例子，前不久的《Python進階：自定義對象實現切片功能》，我在準備素材的時候，竟采用了一個不嚴謹的例子，而且自作聰明地批判了別人的實際無誤的例子。最后，有讀者留言了很長的不同觀點，我才意識到自己的錯誤！

得益于讀者的留言，我修正了自己的錯誤，而且在修正過程中，也加強了對于其它知識的理解，真是塞翁失馬焉知非福啊。

3、內置函數與內置類

這里還有一個客觀性錯誤，藏得特別深，可能真的有 90% 的 Python 使用者不知道。

特別感謝 @xpresslink 同學指出。下面，我給大家分享一下。

在文章《為什么range不是迭代器？range到底是什么類型？》里，我的注意點其實就在標題的兩個問句里，大部分的留言互動也是基于此。但最后，很意外地，一名讀者指出了一個客觀性錯誤，讓我有了額外的收獲。

這位同學指出我有些基本的概念是錯誤的：

“range() 函數”這個說法是非常明顯有錯誤的，range 不是內置函數（ builtin method ）而是個類對象，在 python 里面不要見到用括號調用的東西就認為是函數，類似的還是有很多，如 list, set, tuple, dict 等，這些都是類, 特別是 enumerate ，這個學 python 的人十有八九認為是函數而不知道是類，加了括號是實例化而不是函數調用。

python 中類的實例化和函數調用非常容易對新手有大的迷惑性，相對來說在 java 中有明確的 new 關鍵字加在構造方法前面概念更清楚一些。

根據這個評論，我就去查看文檔。

上圖中 range() 雖然被歸類到 Built-in Functions 里面，但是官方描述的是“functions and types”，即是說，在內置函數的大類下面，包含了內置函數與內置類。

那 range() 屬于哪一種呢？看看它的解釋：

Rather than being a function, range is actually an immutable sequence type......

range 實際是一種不可變的序列類型，而非一個（內置）函數......

按照這里的說法，官方已經區分了 range() 不是函數，正像那位留言的同學所說。

我第一反應當然是不能接受。我怎么會認為它是內置函數的呢，難道不是根據學習資料得來的么？難道我學習的資料是錯的？為何從來沒看到有人對此做過辨析呢？

根據群友的提示，我去查看 Python2 的文檔，然后就發現了很有意思的地方：

首先一點， Built-in Functions 的描述跟 Python3 有點不同，它寫的是 “functions”，并不包含“types”；還有一點，在 range() 和 xrange() 的具體內容中，官方都是稱呼它們為 function 。

由此看來，Python2 的官方文檔就把 range() 當成內置函數，這個認識錯誤是有根源的！等到 Python3 的時候，官方把錯誤改正過來了，然而改得并不徹底。才有了前面同時存在“functions and types”的描述。

官方已經把 range() 與 xrange() 規范為一個，或許在今后版本，還會專門分出一類 Built-in Types 來存放像 range() 和 enumerate() 這些內置類吧。

在那之前，我只能先行給大家提個醒了：別再誤以為 range() 是內置函數了。

那么，怎么辨別哪些是內置函數呢？

我想到了兩個方法：

（1）看是否存在對應的魔術方法。例如，len() 是一個內置函數，因為它實際調用的是魔術方法__len__() ；還有最近一直在提的 iter()，它調用的是__iter__() ，所以也是內置函數；而因為不存在 __range__() 魔術方法，所以 range() 不是內置函數。

（2）使用 type() 進行判斷，結果為 builtin_function_or_method 的才是內置函數。

>>> type(len)
builtin_function_or_method
>>> type(sorted)
builtin_function_or_method
>>> type(open)
builtin_function_or_method>>> type(range)
type
>>> type(enumerate)
type
>>> type(str)
type
復制代碼

像 open 和 sorted 并沒有對應的魔術方法，但判斷出來都是內置函數；而 str 雖有對應魔術方法，但判斷是 type ，這意味著，以上兩種方法得要結合起來看。

我不確定有多少人事先知道怎么區分內置函數與內置類，但我確實沒看到過對這個問題進行辨析的文章，所以，這次是真正漲知識了，也希望這篇文章，能夠消除一些讀者的錯誤觀念吧。