寫作技術文章或圖書的一些經驗

我寫過不少技術文章，也有幸即將出版一本圖書，期間有些許經驗，不敢獨享，整理這篇短文給大家參考參考。

一、寫作是一種修行

我曾經在不同的場合做技術專題的演講，寫博客文章，最後機緣際會有幸集結成書，在相當長一段時間裡我都認為這種轉換是很自然的：我習慣用講課的口吻或者風格寫技術文章，然後天真地認為這些文章整理在一起就很自然地成為了一本書。事實上，這是一個不恰當的假設。講課和寫作，寫博客文章與寫書，是完全不同的三件事情，其所處的情境、受眾都大相徑庭，即便是講同樣一件事情，都需要有不同的表達形式。這是我近些年才慢慢體會，尤其是這次有專業的編輯監督、歷經出版社的三審三校，在每次改稿到快要吐出來的時候強壓住，給自己灌下一碗雞湯後繼續修行的最大心得和經驗。

寫作技術文章或圖書，除了跟一般的寫作一樣需要注意行文流暢、結構合理，以及把事情講明白這些基本要求外，還有一些自己特有的一些注意事項。

二、截圖和代碼

很難想像技術文章或圖書沒有任何截圖或代碼，但在處理這件事情上面，你越早掌握一些原則，則後期要付出的修改的代價就越小。

堅持盡量用讀者熟悉的語言環境做截圖，例如中文。

盡量在圖中圈出重點。

圖片要有編號、上下文需要引用。據說編號對於排版非常重要，而且編輯會一律要求在圖片出現之前用「如圖-11所示」 這樣的文字進行引用。

統一白底黑字，有邊框、不要彩色圖片。因為通常不會用彩色出版，而彩色圖片用黑白印刷很費墨，且不好看。

避免大量的圖片、大圖片、大段的代碼。其實我對於如何有效地展現代碼這個部分還掌握的不好，有經驗的前輩請指教。

三、鏈接

超鏈接（Hyperlink）成就了互聯網，也連接了你我。恰當地運用鏈接可以在多個不同的文章（或者同一個文章的不同節）之間「歡快」地跳轉，讓讀者在一次一次單擊滑鼠時體會到瀏覽的樂趣。

但是如果作為書籍這種形式來說，鏈接不僅要盡量少，而且還有一些嚴格的要求：

除非必要，不用鏈接。

鏈接要合法。盡量用官方網站的鏈接。

鏈接要保證能一直被訪問。注意，Github 的地址會因為某些不可描述的原因偶爾不能訪問。

中英文問題。

四、地圖

最好不要有地圖。最好不要有地圖，最好不要有地圖。

五、文體和語法

如果說上面幾條規則清晰且易於執行，而文體和語法就相對更難，因為這個方面更多的是與作者長期養成的習慣有關，而要改變自己的習慣毫無疑問是不容易的。

避免口語化，盡量不用網路新辭彙。

注意「的、地、得」的使用。據說這幾個字的用法可以作為「漢語八級」的考題，可見要用好它們是相當不易。一個簡答的法則，就是反覆推敲，能不用就不用。

注意「我、我們」的使用。這一條要反覆提醒自己。過多地使用「我」作為第一人稱寫作技術文章或書籍，是不太恰當的。而不恰當（習慣性）地用「我們」則更加危險，因為這將讓表達變得模糊，正如在電視裡面時常可以聽到「我謹代表人民群眾如何如何」一樣，能不能讓人信服另當別論，至少被代表的人民群眾是不舒服的。

注意正確的縮寫和專用名詞。例如W3C是要全部大寫的，而.NET Core既不可以寫成.net core，也盡量不要寫成dotnet core等等。

中英文問題。保持嚴謹且一致的寫作風格，避免一會兒英語，一會兒中文，或者習慣性的中英文混寫。

六、開發實驗環境

技術文章或圖書寫作過程中，不可避免地會用到開發實驗環境，下面兩條建議可參考：

最好有一套獨立的配套環境來做演示。

軟體界面會變化的，要特別注意。

結語

寫作是有趣的，也是有益的，願大家都能重拾寫作這項基本的能力，而如果你正好是從事技術領域的文章或圖書的寫作，了解本文所提到一些簡單的規則，可以讓你避免常見的問題，顯著提高寫作效率的同時也體會到寫作的樂趣。

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！