技術寫作是有技巧的 頂 原 薦

記得2013年9月1日,我開始在“開源中國”上發表博客,兩年內我寫了很多文章,同時也做了自己創立的開源項目,還認識了很多志同道合的朋友,最後也給自己帶來了前所未有的機遇。感謝開源中國,它給我提供了一個很好的平臺,讓我可以在這個平臺上盡情地發揮自己的價值。

其實我在寫第一篇博客之前,就在糾結到底要不要寫?自己能不能寫好?如果寫得不好,會不會被人“噴”?總之,都是一些負面的情緒,讓自己沒有勇氣動手去做這件事情。

記得那是一個週末下午,不知道爲了什麼,我和老婆慪氣了,可能是因爲小孩剛剛出生,每天哭哭啼啼的鬧個不停,我們都被折磨的心力憔悴。老婆在客廳裏發飆,小孩在牀上哭泣,我坐在臥室裏對着“開源中國”網站首頁發呆。

不知道自己是受了什麼刺激,點擊了開源中國網站上的“寫博客”按鈕,於是輕描淡寫地完成了以下這篇短文:

Smart Framework:輕量級 Java Web 框架

從此,自己的技術寫作之路就根本停不下來。

坦率地說,當時寫這篇文章時,我心裏是沒底的。因爲文章中所描述的這是一款開源技術框架,我只是對此框架提了幾點需求而已,當時根本就沒有一行代碼,怎麼能叫“開源項目”呢?我告訴身邊的朋友:

開源並非只是源代碼的開放,而是思想的開放。

因此,我首先開放了自己的思想,然後纔開放了自己的代碼。具體過程是這樣的,首先通過思想去和大家交換意見,然後得出合理的結論,最後產生具體的代碼,再次循環迭代下去。我理解的開源就是這樣的,它的本質其實是一個很有趣的社交活動,它的價值遠遠大於它的產出。

今天是10月24日,1024是程序員的數字,今天是程序員的節日。我想很有必要爲開源中國上的程序員們,寫點自己在技術寫作上的成長經歷與個人體會,希望本文可以給大家帶來一點小小的幫助。

技術寫作的價值

我認爲寫技術文章實際上是對所學技術的再次理解與整理,通過文字的方式讓自己的思路變得更加清晰。寫技術文章需要不斷積累,開頭困難,後面輕鬆,而且積累到一定的量時,會產生質的飛躍,這一點我深有體會,相信寫過技術文章的人也會有同感。

前幾年我寫了一些技術博文,幾乎每週都寫,最頻繁可以做到“每日一博”,而且只在“開源中國”上發表。寫技術文章不僅是對自己專業技能的提升,而且通過技術文章的分享與傳播,還會帶來很多“化學反應”,主要體現在以下幾個方面:

  1. 讓自己的文章能夠幫助更多的人,產生更大的價值。
  2. 讓自己認識更多的朋友,也能從他們身上學到很多東西,包括知識與技能,也包括做人做事的態度。
  3. 讓自己被更多人關注,獲得一生中難得的機會。

當初我就是通過寫技術博客,被電子工業出版社“博文視點”編輯部的陳曉猛老師關注到,陳老師鼓勵我寫書,兩年內出版了兩本《架構探險》系列圖書。

技術寫作的技巧

我認爲寫技術文章,首先要具備的能力是結構性思維。我剛開始寫技術博客時,一開始並沒去列大綱,寫到哪算哪,最後發現篇幅很難控制,而且自己都覺得閱讀起來不太舒服。後來我加以改正,在寫具體內容之前,第一件事就是定義大綱,一級標題、二級標題,複雜情況可能還有三級標題。

定義大綱時是有技巧的,可以藉助“思維導圖”工具來完成,而且大綱標題需要做到言簡意賅。第二件事就開始完善每個大綱中的內容,寫文章類似於我們寫程序,先要定接口(大綱),再寫實現(內容)。

在寫內容時也有技巧,比如:

  1. 要讓讀者感受到,閱讀這篇文章就像是作者在和讀者對話一樣,文章中可以用“我”或“我們”來表示作者,用“您”或“大家”表示讀者。
  2. 而且要多用短句,避免長句,目的是讓讀者閱讀起來更加舒服,如果感覺句子太長時,可以在合適的地方用逗號斷句。
  3. 想讓讀者更有興趣往下讀,可以在正文開頭編一個段子,但這個段子最好與文章有些關聯性。
  4. 文中插圖要繪製精細,一定不要隨意,正所謂“一圖勝千言”,圖好,文也好,纔是真的好。
  5. 文章結尾時一定要有總結,讓讀者讀完文章後,能夠快速抓到重點,產生一種“深入淺出”的感覺。
  6. 不管對自己所寫文章是否有把握,都要在結尾處表明文章還有很多不足,希望得到大家批評與指正的話。

最後一件事情是爲文章起一個吸引人的標題,一個好的標題會讓文章獲得更多的點擊量和傳播率,好文章往往就是內容好,而且標題也好。技巧還有很多,自己動手寫起來以後,就會產生很多經驗。

如果擔心自己無法堅持寫下去,不妨給自己設置一個計劃,比如多長時間可以寫一篇文章。如果不知道自己應該寫什麼,不妨將自己從日常工作中所學到的技能做一個總結,當然也可以寫自己的讀書筆記或心得體會等。總之,寫作興趣是可以訓練出來的。

從寫博客到寫書

記得出版社老師鼓勵我寫書時,我也擔心自己寫不出來,畢竟一本書不像一篇博客,書的篇幅較大,前後還有一定的前後關聯性,需要較強的內容組織能力,更需要堅強的毅力。我在寫第一本書時,一口氣寫了50多頁,然後就寫不下去了,因爲覺得框架組織有問題。隨後捲土重來,第二次寫到100多頁,仍然覺得不合理,再次放棄。直到第三次才一氣呵成,寫完了全書。花費了我將近半年的時間,才能寫完一本書,可見週期較長,讓人心力憔悴。

我在寫第二本書時,總結了曾經犯下的錯誤,吸取了教訓。一開始我就花了大量的時間做全書的大綱,通過三級標題來展現。第一章作爲概述性內容,統領全書中心思想,隨後的每一章,分別對第一章所涉及的內容,進行深度描述,每一章都是一個獨立的板塊,每一節都針對一個具體的問題。每章都按照統一的邏輯來組織,首先講明白“是什麼”,再講“爲什麼”,最後講“怎麼做”。每章最後一節再來一個小結,彙總一下本章的要點,以及爲下一章做一個鋪墊。

按照以上方法,不僅讓自己的寫作思路更加清晰,而且也把寫書當成一個項目來管理,這樣自己也能更加有毅力地將全書寫完。

最後的贈言

不要吝嗇自己在知識上的積累,更不要將知識據爲己有,知識用出來纔是珍寶,悶在肚子裏那是廢物。


作者簡介

黃勇,現任特贊科技 CTO,曾任阿里巴巴公司系統架構師。具有豐富的互聯網軟件架構經驗與技術管理經驗,擅長敏捷開發模式,推崇“輕量級”系統架構。國內開源軟件推動者之一,活躍於國內知名技術社區,Smart 開源框架創始人,暢銷書《架構探險》作者,技術大會講師,企業內訓師。熱愛技術交流,樂於分享自己的成長經驗。

特贊公司 www.tezign.com

特贊是一個具有創意基因的互聯網技術團隊,來自於人工智能、人機交互、大數據、SaaS 軟件服務化、創意管理、廣告媒體等跨學科背景的成員組成,畢業於哈佛大學、普林斯頓大學、哥倫比亞大學、復旦大學、浙江大學等國內外知名學府和 Facebook、阿里巴巴、新浪、盛大、豆瓣、奧美、Isobar 等著名公司工作經驗。


點擊獲取《架構探險:從零開始寫 Java Web 框架》

架構探險1

點擊獲取《架構探險:輕量級微服務架構》

架構探險2

點擊獲取《架構探險限量版戰袍》

架構探險 T 恤

架構探險圖書微信公衆號

架構探險圖書

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章