7.2. 如何编写文档

Caudium 需要两种类型的文档

• 新闻文章。

  您可以撰写关于 Caudium 的新闻文章。

  	法语作者请注意
  	您可以联系我们。

  这种类型的文档通常不是很有帮助，因为社区中很少有人会阅读它。它主要用于广告宣传（即使您撰写了一篇非常技术性的文章，它也是有用的）。

• 可从互联网获取的文档。

  这种类型的文档是必不可少的；没有它 Caudium 就无法存在。此文档将帮助 Caudium 的新手，并且对开发人员也很有用。开始使用 Caudium 的一个好方法是使用 Roxen 1.3 文档。开发人员还应该查看 autodoc。这些是在源代码中制作的内联文档，并以格式化的 HTML 输出形式在 http://caudium.net/ 上提供。

  对于开发人员来说，也缺乏更深入的文档。示例包括如何编写非阻塞套接字代码，如何使用回溯，如何使用do_output_tag，以及我应该在何时放置thread_safe=1。我记得花了好几个小时在 IRC 上试图理解其中的一些事情，但没有任何文档可用。这种文档应该由顶尖的开发人员之一编写。

  此文档是使用 XSLT 编写的，但是如果您不了解它，那也没问题。请给我们您想要的任何格式，我们会将其翻译过来。语言也是如此。如果您不会说英语，您可以使用您自己的语言编写，我们将进行翻译。我们还将仔细校对您的作品，以纠正您可能留下的任何拼写错误或不准确之处。

  要编写这种类型的文档，请联系负责文档项目的人员，ice at caudium dot net。