最近iThome「iT邦幫忙」的「鐵人賽」的活動,正在如火如荼的展開。傳統我們所認知的鐵人賽,不論是跑步、游泳、或是騎單車,給人的印象都是必須很有耐心、很有毅力地持續完成一項運動。而鐵人賽的精神也差不多,只不過,把活動的型式從運動轉換成為技術寫作而已。在這個競賽裡,必須三十天不間斷地,針對同一技術主題,每天都完成一份文稿,而三十天的文稿又得妥善安排它們的組織及綱要。能夠完成這個競賽,基本上堪稱之為鐵人。

我曾經擔任過幾次「IT 鐵人賽」的評番,每次在閱讀參賽者的作品時,心裡都難免有些或多或少的感動。也很佩服許多參賽者能夠在連續一個月的參賽期間內,不間斷地針對同一個技術主題進行寫作。在這個過程中,不僅要考慮到所訂主題的新穎性、貢獻度、有趣程度,還得規畫在漫長的三十天內,鋪陳整個主題的先後次序及脈絡關係,可以說是存在不少的難度。

除了佩服這些參賽者之外,這也讓我同時想起了多年前部落格寫作的風氣正盛的時候,在臺灣有許多的技術部落格寫作,這些技術文章讓許多技術圈子裡的朋友都得到了許多資訊的幫助。大家都知道,在開發時,不論是需要入門的教學文章、或是解答特定的疑難雜症,網路上的文章,往往都能起到很大的作用。

很可惜的是,這種部落格寫作的風氣,在臺灣這幾年似乎減弱了不少,而這從我的觀點來看,是一件很可惜的事情。

加深印象,記錄心得

其實我是很鼓勵軟體的開發人員多多從事技術寫作。雖然,大多數的人,都很難透過技術寫作的活動,來獲得實質的商業獲利。尤其當作品免費置放在網路上供讀者瀏覽時,除了某些人或許會有的微薄廣告收益之外,大多數的技術分享文章,看起來真的是「佛心來著的」。

既然是如此,為什麼我還覺得應該鼓勵軟體的開發人員,多多從事技術寫作呢?

侯捷大哥曾說:「發表是最好的記憶」。發表一篇技術文章的目的之一,不在為旁人,而是在自己。大凡技術人員,多有從事技術涉獵、探索的過程,在完成這過程付諸實作之後,也常因此蘊生出自己個人的心得。

而發表,就是記錄這些心得的方式。倘若沒有加以記錄,或許假以時日、或許再參研其餘的技術,又把之前研究出來的種種心得細節給遺忘了。有了記錄,日後即使忘掉了部份細節,參照著過去的記錄,也就可以輕易的把這些心得從腦海的深處重新喚回。

為了說清楚、講明白,對於所要討論的主題必須了解得更透澈

除了記錄、備忘的作用之外,我認為寫作對作者來說還有一個好處,就是可以把想要解說的事情想得更清楚、更明白。

很多時候,我們以為我們懂了一個技術的原理,因為我們已經有辦法把它實作出來了。但是,當你想要把這些原理透過文字或圖表說明出來時,所假設的讀者往往不是你自己而已,反而常常會假想讀者乃是一個全然陌生人的角色。為了向一個多半不知道前因後果、也缺乏情境的讀者說明,你會嘗試著組織文章的結構,以便讓讀者明白你想表達的想法和觀念。

而也正是在這種揣摩讀者能否理解的過程中,你會去思考你所以為領悟的事情該如何表達才好,在這過程中,往往也幫助你理解想說明之物的本質。

這種情況也就是你以為你懂了,事實上,你沒有你想像中的那麼懂。

在嘗試著透過文字向讀者說明的過程中,你會思考該如何表達,以致於你發現了自己也沒搞懂或想清楚的地方,於是你最終想通了,也總算能完整地向讀者呈現了。因此,這個向他人呈現的過程,也同樣是個幫助自己歸零重新探索的過程,對於技術人員的幫助,其作用不在記錄之下。

增加與讀者互動的機會,利己也利人

此外,透過技術寫作的最後呈現,也就是發表,你有機會得到來自全世界各地的人給你的回饋及指教。有些是鼓勵,或許有些是質疑。質疑很好,在回答質疑的問題同時,你可能更確信自己的想法,也可能找出自己想法或說法上的漏洞。無論是那種,無疑都能幫助你更加精進。

技術寫作,除了對自己有助益之外,對其他人的幫助自不在話下。有時,即使只是個小小的問題,但因為有你具體的寫下可能的原因及解法,就可以對或許遠在千里之外的讀者派上用場,節省很多他自行排除疑難的時間。我想我們都有相當多從網路上找到的技術文章獲得極大幫助的經驗。有時在深夜獨自尋問技術解答的同時,不經意地找到了一篇足以提供答案的文章時,那種雀躍之情,相信都是溢於言表。

更重要的是,當這種技術寫作的風氣能夠興盛,就更有機會產生良性的互動、建構出一個技術分享交流的生態系。

當大家都能從別人的文章中獲益,之後也會更願意貢獻自己所知、所得的事物來和所有人分享。而更多人愈願意分享,就能產生更多的養份,將滋養更多人做更多的分享。

或許有些人對自己的作品會有「野人獻曝」的考慮,因而降低寫作及分享的意願。或許是考量到自己的文字能力,或許也會考量到自己覺得並不是多麼高深的技術,因而對於寫作及分享卻步。

其實,技術又如何能輕易分出高下?任何技術議題不分高下,都需要有人討論、介紹,因為任何議題都有它的對象,並不是每個人都需要艱深的技術內容,大家所需要的,都是剛好符合需求的,而在需求的光譜上,各種類型的技術議題,其實都有大眾需要。

即使只是你自認是小小的心得,因為你有此需要,代表著這個世上也應該有人需要。跨過這道心理障礙,你會更樂於分享。

可逐漸精進書寫表達的能力

此外,就是文字書寫的能力了。相反的,我不認為這應該構成你從事寫作的障礙,這反而應該是你更應該勤於寫作的原因。在我們當中的大多人,包括我在內,都不是寫作的天才。而我們所能憑藉著讓寫作能力進步的方法之一,就是透過不斷的寫作,經由長時間的練習及積累,將寫作的能力逐步提升。

再者,你的技術文章發表,也能擴展你和社群中其他同好間的聯繫。讓你更有機會認識有相同研究興趣的朋友,增加交流的可能。這的確對彼此之後的視野都有正面的幫助。

若能藉此提高知名度,讓自己站上一定的舞臺,不僅有更多接觸高手的機會,對於職場上應徵工作也有明顯的好處。

總而言之,技術寫作的好處多多。在這麼些年來,我也累積了一些的文字記錄,記錄著不同時期對軟體開發、程式設計技巧的看法及觀點。回首這段歷程及產出,很慶幸的自己做了這些記錄。此時再回顧過去的想法,或許不見得認同過去的想法,甚至看出諸多自認不成熟之處。但也正好有這些產物,足以記錄自己成長的軌跡,也算是自己對自己的見證吧。

既然這麼多好處,你還不快拿起鍵盤,開始寫些什麼吧!

作者簡介


Advertisement

更多 iThome相關內容