搜尋此網誌

工商服務

2009年1月16日 星期五

電腦文章的寫作理論與標準作業流程

我通常都覺得寫電腦雜誌稿並不難,只要經過組織和規劃,也就是想想看要怎麼寫,之後只要依序將那些項目寫出來就好了。

一般的架構就是會有〈前言〉和〈結語〉,然後中間主體內容的部分就是程式碼與程式運作方式的講解,比方說近期寫的是剖析一套開放原始碼專案的文章,它裡面包含了4個主要的程式碼檔案,因此基本上只要一個接著一個講完即可,而在介紹的時候當然也是從程式碼當中挑選重要的部分來講,至於取捨準則全憑經驗、篇幅需求和文章深淺屬性而定了。

所以只要把〈前言〉和〈結語〉寫完,中間那些段落寫起來都非常快了,而且字數增加的速度經常超乎想像,簡直無法預期。

所以我覺得這類電腦文章反而是好寫的,你也不需要有太多的寫作技巧(相較於小說散文而言),把東西寫得夠詳細、寫得大家都看得懂(至少自己和責任編輯要看得懂),用對待初學者的親切口吻來敘述,再輔以旁徵博引的表格和提示框框。這個原則其實就跟《簡單的法則》裡頭的法則4所提到作法是相同的。

我以前曾經犯過錯,就是把讀者都當作太強了(事實上,如果很強的話就不需要來看別人寫的文章啦),導致責任編輯看得霧煞煞的,所以我後來就重新調整步伐,把文章盡可能地寫得很粗淺、很明白,用一般老百姓都聽得懂的話在寫(不過這當然只是理想啦,寫技術文章不可能不穿插幾個專有名詞的嘛)。

此外,不可諱言地,〈前言〉和〈結語〉這兩個地方通常是我著墨和思考最久的地方(想著怎麼引人入勝,又怎麼餘味猶存),因此往往看得我自己樂趣十足。但也不是說中間的部分就只是一些冗長文字的搪塞,畢竟文章真正的精華還是在此,是技術含量最集中的部分,每段都是是嘔心瀝血之作呀,只是說敘述鋪陳比較平淡可能也是在所難免,但求語意明白不會含糊不清。

而且很有趣的是,文章寫久了你就會知道哪裡該怎麼下筆、哪裡該怎麼轉折、如何用字遣詞之類的,而這就是日積月累的練習(唉呀,寫文章能有什麼練習勒,就是多寫、時常寫而已嘛,)努力之後,所產生的潛移默化的力量。

另外寫這類文章時真正必須下苦工的地方在於,必須對讀者循循善誘,他們才能往前走。所以文章必須深入而淺出,而這就是最困難的地方了,要想辦法把複雜的東西用簡單的方式表達出來。

總而言之,前面講的大致上是寫作理論的部分,至於標準作業流程嘛:就是把擬定好的主題依序寫完,畢竟那些要講的東西(即程式碼本身)本來就存在那裡了呀,所以你只管把值得介紹的部分挑出來,然後組織一下寫出來就是了。

我自己的習慣是會把大概的幾個標題先訂好,然後在個別標題之下塞入收集到的資料的隻字片語,再由此長成句子、由句子匯成段落,最後形成通順有次序兼完備的小節。

至於在寫文章之前,必須先找好題目(怎麼找嘛,通常運氣運氣啦,靈感來的時候瞬間一次冒出5篇主題都有可能),寫完文章之後要再找適合的發表園地來刊登就不用提了,講起來只是廢話多說而已。

印象中,我在當兵前曾經寫過一份投稿PHA的標準作業流程(SOP),只是後來似乎並沒有照著做就是了。更大的原因是我後來幾乎就沒有再投稿過PHA了,因為似乎持續投稿的習慣一旦中斷了,便很難再恢復。有空去翻出來的話,再來補充說明囉。

【2009.01.20 updated】

看非凡新聞介紹美國麥當勞當初的兩位創辦人所制訂的SOP,居然厚達75頁,舉凡管理層面和製作層面的各種相關議題,無所不包。

事實上,麥當勞之所以稱霸速食業,以及成為跨國的標竿企業,就在於他們將這套SOP嚴格施行,不斷改善與複製到不同文化與地區去。

所以我還是應該要靜下心來,把相關步驟條列式寫出來比較好,也方便核對有無作業上的缺失。這樣我的寫作版圖才會逐漸茁壯擴大下去。

沒有留言:

張貼留言