Luar's Flash Playground:怎樣寫一篇好教程
怎樣寫一篇好教程 (31-10-2004)

凡熱愛技術的人,都喜歡跟別人分享自己心得,寫了一篇教程出來,如果取材掌握不好,往往其他人沒法看得明白,什麼都學不到,白白浪費了一篇教程。

首先,一篇教程必須先交待好背景,例如因為什麼問題、困難,引起對某方面研究,從而得到一點心得,這樣以後其他人遇到同樣問題,都知道可以參考這篇教程。另一方面,由於Flash玩家,大多不是計算機專業出身,所以背景資料上,最好多交待一下這技術心得是由那些基本知識建立起來,旁加一些其他參考註解,方便他們自行學習。我看過一些教程,題材其實頗專門或深入,因為缺乏背景交待,我自己都看得吃力。寫教程時,經常要抱著心態:自己已經知道的,別人未必知道;自己已經明白的,別人未必明白。

到了寫技術心得部分,先講解它背後概念,怎樣想出來?怎樣建立起來?遇到比較抽象概念時,就多作比喻。講解時,先由基本構成部分,例如功能上簡單部分講起,配以幾句簡單ActionScript,一步一步加上去,再這樣寫下去有何理由?如何再改善編程?最後才得出整個技術出來。最失敗的教程是那些一開始便將整個ActionScript寫出來的,沒有任何解說,或者只不過是逐行ActionScript解說。就好像解數學題目般,直接將答案寫出來,略過演算部分,一定得不到最好分數,老師一定不滿意。

講解同時,最好多羅列幾種不同做法,比較他們好壞處,使讀者有更廣闊思考範圍,更可以讓自己反思現在想到的技術心得是否最好。

最後,自己研究過程中,曾從別人東西得過益,請加上鳴謝或其他參考資源,讓讀者可以更進一步學習。

這兩篇文章,一篇是理論文章《你需要Flash Remoting嗎?》、一篇是技術文章《神秘的Garbage Collection》,我覺得自己寫得不錯,讀者反應也好,可以作為學習寫教程參考。

本文章由發表。
同組文章