Documentation Team

The role of this team is to write and maintain documentation. Since the current focus of the project is on appealing to developers, the Documentation team currently focuses on documenting the Application Programmer Interface (API).

• Mailing list (archive)

Team Members & Contributors

Members:

• Niels Sascha Reedijk
• David Weizades
• Thom Holwerda

Contributors:

• Miguel Zuniga
• Alan Smale

To learn more about the team structure, visit the page that explains what it means to be a contributor and a member, and how to join in.

Areas Requiring Contribution

We are currently focusing on writing the API documentation and we are looking for help in this area. If you are interested, please send a message to the mailing list. To write API documentation, you should have the following skill set:

• Have a basic understanding of the terminology of C++ and the way API´s work.
• Be able to read header files.
• Have an interest in writing technical documentation.
• Have at least four hours a week to spend on writing, rewriting and reviewing documentation.

Of course, we are always in need for proofreaders. If you are a beginning developer, we´d like your input on areas that are unclear. If you are a native speaker of English and you have affinity with spelling and grammar, we also would very much appreciate your help. Don´t hesitate to contact us in case you think you might be a valuable addition to the team.

At the moment the focus is on API documentation. However, if you have some experience or talent in the area of user documentation, and you are able to create a concept and defend it, the mailing list is definitely the place to send your ideas.

Resources

Check out Haiku Documentation Team How-To for details on getting started with contributing to the Haiku documentation and the software you will need. Another important document is the one on how the team is organised and how you can become a full member. Also, the current status of the documentation can be found at the WIKI.