[haiku-doc] Update Documentation Team Webpage
- From: "Niels Reedijk" <niels.reedijk@xxxxxxxxx>
- To: "Waldemar Kornewald" <wkornewald@xxxxxxxxxxxx>
- Date: Fri, 13 Apr 2007 15:28:46 +0200
Hi Waldemar,
Could you please update the team page of the Documentation team with
the following? And if you updated it, could you prod Michael Phipps to
place the announcement on the website? I probably won´t have internet
access this weekend (university´s closed).
Thank you,
Niels
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 focusses on documenting the Application
Programmer Interface (API).
Mailing list [//www.freelists.org/list/haiku-doc] (archive
[//www.freelists.org/archives/haiku-doc/])
See the output of the build factory
(http://factory.haiku-os.org/documentation/Haiku_Book_doxygen/html/)
for the current status of the API documentation.
Team Members and Contributors
----------------------------------------------
*Contributors*
Niels Sascha Reedijk
Miguel Zuniga
Alan Smale
Areas Requiring Contribution
------------------------------------------
We are currently focussing 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 skillset:
- 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
definately the place to send your ideas.
Other related posts:
- » [haiku-doc] Update Documentation Team Webpage
