<< Back to man.ChinaUnix.net

Next Previous Contents

4. 写一份 HOWTO

如果你有兴趣写一份 HOWTO 或 mini-HOWTO,请先与我联络!!! 我的地址是 linux-howto@metalab.unc.edu.

这里有一些当你写一份 HOWTO 或 mini-HOWTO 时应遵守的准则。

  1. 尝试使用有意义的结构与组织,并写得清楚些。请记住许多 HOWTOs 的读者并非以英文作为母语的。
  2. 如果你在写一份 HOWTO,你必须 使用 SGML-Tools 工具,可从 http://www.sgmltools.org/ 取得。这个工具可以让我们经由单一原始文件产生 LaTeX (DVI 及 PostScript) 文件,纯文字,以及 HTML 格式,而且它是特别设计用来写 HOWTOs 的。这也使得所有的 HOWTOs 文件看起来具有一致的形式。你事先将文件格式化并检视 PostScript,纯文字及 HTML 的输出是十分重要的。
  3. 如果你在写一份 mini-HOWTO,你可以使用 SGML (如上所述) 或是 HTML 格式。如果你使用 SGML 格式,它会和其它 HOWTOs 一起被放入 LDP 的书中出版。
  4. 请确定所有的信息都是正确的。不需我强调这点的重要性。如果有所怀疑,不能确定,请在文中清楚的注明你仅仅是在猜测而已。
  5. 请确定你包含了最新版本的软件。同时,确定包含了如何取得软件的全部信息(FTP 站名及全部的路径名称),目前的版本以及发行日期等。
  6. 如果合适的话,在最后面包含一节“常见问题解答(FAQ)”。许多的 HOWTO 文件需要“FAQ”或“常见问题”一节来涵盖内文所未包含的信息。
  7. 使用其它的 HOWTOs 或 mini-HOWTOs 做为范本。SGML 的原始档也可以从 Linux FTP 站取得。除此之外,看一下 LDP Style Guide 里的一些建议。
  8. 请确定在文件开头处包含了你的名字,email 地址,日期以及版本信息。如果必要也可以包含你的 WWW 地址或永久住址。标准的开头就像这样:
            标题
            作者姓名及 email 地址
            版本号码及日期
            
    
    例如:
            The Linux HOWTO Index
            by Tim Bynum
            v2.10.29, 31 July 1997
            
    
  9. 最后,准备好接到一大堆的问题与意见。全世界每天都有数千次造访 HOWTO 文件的收集站。

在你写完 HOWTO 之后,将它寄给我。如果你用 SGML-Tools,直接将 SGML 原始档寄给我就行。我会负责编排这些文件,将它放到 metalab.unc.edu 并且在不同的新闻组群上发表。

经由我发表一份 HOWTO 是很重要的,因为我维护这些文档并且追踪已经写了哪些 HOWTOs,以及谁做了什么等等。

然后,你所要做的就是在定期更新并将文件寄给我。

[译注]

如果你有兴趣翻译一篇 HOWTO,请先看 如何参与 Linux HOWTO 中文翻译计划,并与 CLDP 协调人 黄志伟 联络。


Next Previous Contents