Linux HOWTO 中文索引
: 寫一份 HOWTO
Previous: HOWTO 索引
Next: 版權聲明
4. 寫一份 HOWTO
如果你有興趣寫一份 HOWTO 或 mini-HOWTO,請先與我聯絡!!! 我的地址是
linux-howto@sunsite.unc.edu
.
這裡有一些當你寫一份 HOWTO 或 mini-HOWTO 時應遵守的準則。
- 嘗試使用有意義的結構與組織,並寫得清楚些。請記住許多 HOWTOs
的讀者並非以英文作為母語的。
- 如果你在寫一份 HOWTO,你必須 使用 SGML-Tools 工具,可從
http://www.xs4all.nl/~cg/sgmltools/
取得。
這個工具可以讓我們經由單一原始文件產生 LaTeX (DVI 及 PostScript) 文件,
純文字,以及 HTML 格式,而且它是特別設計用來寫 HOWTOs 的。
這也使得所有的 HOWTOs 文件看起來具有一致的形式。
你事先將文件格式化並檢視 PostScript,純文字及 HTML 的輸出是十分重要的。
- 如果你在寫一份 mini-HOWTO,你可以使用 SGML (如上所述) 或是 HTML 格式。
如果你使用 SGML 格式,它會和其它 HOWTOs 一起被放入 LDP 的書中出版。
- 請確定所有的資訊都是正確的。不需我強調這點的重要性。
如果有所懷疑,不能確定,請在文中清楚的註明你僅僅是在猜測而已。
- 請確定你包含了最新版本的軟體。同時,確定包含了如何取得軟體的全部資訊(FTP 站名及全部的路徑名稱),
目前的版本以及發行日期等。
- 如果合適的話,在最後面包含一節「常見問題解答(FAQ)」。
許多的 HOWTO 文件需要「FAQ」或「常見問題」一節來涵蓋內文所未包含的資訊。
- 使用其它的 HOWTOs 或 mini-HOWTOs 做為範本。SGML 的原始檔也可以從 Linux FTP 站取得。
除此之外,看一下 LDP Style Guide 裡的一些建議。
- 請確定在文件開頭處包含了你的名字,email 地址,日期以及版本資訊。
如果必要也可以包含你的 WWW 地址或永久住址。標準的開頭就像這樣:
標題
作者姓名及 email 地址
版本號碼及日期
例如:
The Linux HOWTO Index
by Tim Bynum
v2.10.29, 31 July 1997
- 最後,準備好接到一大堆的問題與意見。全世界每天都有數千次造訪 HOWTO 文件的收集站。
在你寫完 HOWTO 之後,將它寄給我。如果你用 SGML-Tools,直接將 SGML 原始檔寄給我就行。
我會負責編排這些文件,將它放到 sunsite.unc.edu
並且在不同的新聞組群上發表。
經由我發表一份 HOWTO 是很重要的,因為我維護這些檔案並且追蹤已經寫了那些 HOWTOs,以及誰做了什麼等等。
然後,你所要做的就是在定期更新並將文件寄給我。
- [譯註]
如果你有興趣翻譯一篇 HOWTO,請先看如何參與 Linux HOWTO 中文翻譯計畫,並與 CLDP 協調人 黃志偉 聯絡。
Linux HOWTO 中文索引
: 寫一份 HOWTO
Previous: HOWTO 索引
Next: 版權聲明