- User documentation
- Developer documentation
- Code documentation (http://www.phpdoc.org/)
Updated by Yannick Warnier about 10 years ago
User documentation itself has to be subdivided into 3 documentations: student, teacher and admin (and other roles). Even if the roles are more flexible in Chamilo 2.0, there will still be a need for people to identify themselves with one or more classical profile.
Also, while generating documentation meant to be provided as PDF or office documents, and in order to improve translatability, it is very important to write each chapter in a separate document, then use the OpenOffice.org feature of "master document" in order to join them.
This allows for a quick distribution of chapters through a team of community members that can join efforts to translate a full document simultaneously (for example during a monthly meeting).
Master documents essentially mean joining several documents into one, and only then generating a table of contents. Children documents can be set to define a title of level 1 each, plus a set of subtitles. The original document is then the only one that really require a huge amount of work.