全站文章 iT邦幫忙
iThome Online提供免費電子報,現在就訂,最新IT訊息每日寄達。

iThome 每日新聞報
iThome 產品技術報
加入iThome Online會員,立即使用討論區、Blog等服務。

免費加入會員
登入 / 登出
管理會員帳號
忘記帳號密碼
聯絡客服
訂閱周刊
讀者服務
13' E政府專刊no.7(48)
13' iTcloud No.3(47)
12' E政府專刊no.6(46)
12' 個資法專刊No2(45)
12' iTcloud No.2(44)
12' e政府專刊No.5(43)
12' 個資法專刊(42)
11' CIO專刊(41)
11' e教育專刊No.3 (40)
11' e政府專刊No.4 (39)
11'iTcloud專刊(38)
10' e教育專刊No.2 (37)
10'e政府專刊No.3 (36)
09'e政府專刊No.2 (35)
09'e教育專刊(34)
09'e政府專刊(33)
08'企業資安專刊-端點安全防護(32)
08'企業採購情報誌(31)
07'資訊安全技術應用專刊(30)
07' 新世代資料中心專刊(29)
07'企業資安技術應用專刊(28)
企業採購情報誌'06冬季號(27)
手不離鍵盤的輕量標記語言
文/林信良 2014-01-24
分享到facebook
開發人員撰寫程式碼之餘,技術寫作也是需要進行的工作項目,而這當中也需要注意專注寫作方式

林信良
因在網路上經營「良葛格學習筆記」(openhome.cc)而聞名,曾任昇陽教育訓練中心技術顧問、甲骨文教育訓練中心授權講師,目前為自由工作者,從事講師、技術書籍寫作與翻譯,專長為Java 程式開發相關技術教育訓練,研究興趣包括:程式語言、Web 相關開放原始碼框架。閒暇之餘記錄所學,技術文件涵蓋 C/C++、Java、Ruby/Rails、Python、JavaScript 等領域。

專業的程式開發者,撰寫程式時會留意未來可讀性,透過適當編輯工具與程式樣版定義,可讓開發者無需分心於程式碼結構與風格,專注於程式內容的撰寫。

優秀開發者亦會從事技術寫作,良好技術文件就如同良好程式碼,若能認識並透過適當工具輔助,開發者就能專注於技術寫作內容,而非紛擾於文件的結構、樣式、雜亂的格式,甚至是文件版本。

專業的技術寫作者,對於其撰寫內容如何呈現也必然有所要求,著名技術作家侯捷便十分重視文字呈現,為了避免他的書中任何一個字一張圖的大小型式顏色粗細位置……不在他的完全掌控之下,他決定親自排版,甚至因此出版了《Word 排版藝術》來分享其排版經驗,他在自序中談到:「文字欲以悅目的形象出現,就需要良好的編排。」

我在從事書籍寫作或翻譯時是使用Word,也研讀過《Word 排版藝術》,不過幸運地,我遇過的編輯認真負責,排版者也有相當高的專業,因而我無需全盤操控編排的每個細節,使用Word之目的,單純是想大致呈現排版外觀,我會事先擬訂好章、節、列點、標號、圖示、程式碼等結構,接著就專注於內容編寫,排版者在我的基本排版外觀下,考量印刷效果並進行樣式套用,後續再透過數次校稿過程,確定實體書籍具有良好編排。

如果是編寫網站上可閱覽的系列文件,我選擇使用HTML文件,HTML有定義結構用的標籤,可使用純文字編寫,可透過樣式表來決定編排樣式,似乎是最佳的選擇;不過標籤與樣式,顯然較適合給機器讀取而不是給人閱讀,因而我會有個樣版網頁,事先定義好文件的結構與樣式表,每篇新文章都使用樣版網頁,搭配所視即所得HTML編輯器(早期使用Nvu、KompoZer,現在使用BlueGriffon),以求能專注於內容的撰寫。

寫作iThome專欄我有些自我要求,內容不能只是教學文件,不能只是「掉書袋」純談沒接觸過或親身體驗過的東西,偏好結合近日從事活動中看到、聽到且有深刻想法之論述,因而在各種寫作主題中,寫作iThome專欄最具有挑戰性,為了徹底專注於內容,我使用的工具是純文字編輯器NotePad++,通常事先只擬定四個子標題,每個子標題前放個「-」符號作為識別,這可避免我分心思考額外的綱要層次,也避免了各種樣式操作上的紛擾。


1 / 2 / 3 下一頁

分享到facebook

2014資安趨勢研討會
更多研討會
▼ ADVERTISEMENT ▼
▲ ADVERTISEMENT ▲

電週文化事業版權所有、轉載必究 •Copyright © iThome | 刊登廣告授權服務服務信箱隱私權聲明與會員使用條款關於iThome