Project

General

Profile

Feature #11

Documentation

Added by Sven Vanpoucke over 9 years ago. Updated almost 8 years ago.

Status:
Bug resolved
Priority:
Normal
Target version:
Start date:
16/10/2009
Due date:
% Done:

100%

Estimated time:
Complexity:
Normal

Description

We need 3 levels of documentation

History

#1

Updated by Yannick Warnier over 9 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.

http://dokeoslead.wordpress.com/2009/07/27/pre-translating-a-large-rich-text-document/

#2

Updated by Stefaan Vanbillemont about 9 years ago

  • Assignee set to Stefaan Vanbillemont

We are going to start taking a look at phpdocumentor and other software to make 'something' available as documentation. More to come the next couple of days.

#3

Updated by Stefaan Vanbillemont about 9 years ago

  • % Done changed from 0 to 20

Ok, we used Doxygen to generate some code documentation: http://developers.chamilo.org/
I think this is sufficient for now. I hope to add some more general information on that front screen.

#4

Updated by Stefaan Vanbillemont about 9 years ago

  • Status changed from New to Bug resolved
  • % Done changed from 20 to 100
#5

Updated by Stefaan Vanbillemont almost 8 years ago

  • Project changed from Chamilo LCMS Connect to Handbook
  • Category deleted (20)
#6

Updated by Stefaan Vanbillemont almost 8 years ago

  • Target version changed from 3 to 1.0.0

Also available in: Atom PDF