How to write documentation

Caudium HOWTO
Prev | Chapter 7. How to help the Caudium community | Next

# 7.2. How to write documentation

There are two types of documentation needed for Caudium:

- Press articles.

  You can write press articles about Caudium.

  | Note for French writers:
  | You can contact us for that.

  This type of documentation is usually not really helpful since few in the community will read it. It is useful mainly for advertising (even if you made a very technical article, this is useful).

- Documentation available from Internet.

  This type of documentation is a must; Caudium can't exist without it. This documentation will help Caudium's newbies, and will also be useful for developers. One good way to start with Caudium is using the Roxen 1.3 documentation. The developers should also see the autodoc. These are in-line documents made in the sources, and available as formatted HTML output at http://caudium.net/.

  There is also a lack for a more in-depth documentation for developer. Examples include how to code non-blocking sockets, how to use a backtrace, how to use the `do_output_tag`, and when should I put `thread_safe=1`. I remember spending hours trying to understand some of these things on IRC without any documentation available. This sort of documentation should be written by one of the top developers.

  This documentation is written using XSLT, but if you don't know it, that's not a problem. Give us whatever format you want, we will translate it. It is the same for the language. If you don't speak English, you can write it in your own language and we will translate. We will also proof-read your work carefully in order to correct any typos or inaccuracies you might leave.

  To write this type of documentation, contact the person in charge of the documentation project, ice at caudium dot net.

Prev | Home | Next
How to promote Caudium | Up | How to get a CVS account