Documentation Manager Guide
Contents |
[edit]
Description
- Workspace of: Documentation Manager
- Main Guides
- Documentation Manager Guide
- Jajuk Manual Contributing Guide
- Active tickets (Trac)
- Workspace's Tickets
The doc manager is responsible for the documentation health. He will probably be doc writer himself but also organizes and manages others contributors in this area.
[edit]
Detailed roles
- Making sure the current English and French manuals evolves with the new releases
- Making regular cleanups in the doc, taking users feedback into account
- Recruiting / managing doc writers or write doc himself on the wiki website
- Eventually starting new language manuals
- Making animations (Flash demos) in order to be accessible from the website
- Making a "New and Noteworthy" wiki page at each release
- Feed the TOTDs (Tips Of The Day)
- Bringing new ideas of documentation (tutorials, guided tours...)
[edit]
Required Qualities
- Have enough time for this (lets say 30 hours / release, 1 release every 6 months)
- Be organized, friendly and possibly having experience in managing people
- Have a very good knowledge of jajuk functioning and current documentation
- Follow new features by subscribing to the dev and commit lists
- Be innovative to propose and manage doc improvements
[edit]
Managing documentation and images in Jajuk
Notes that all pictures in Jajuk can be found in the wiki, but some pictures of the wiki are not in Jajuk. Only the pictures for the manual can be uploaded from the wiki to Jajuk.
[edit]
Images in the SVN
- Pictures used in Jajuk are manually upload using the SVN
- The list of pictures used in the SVN are generated using Generating images list for the wiki and this list can be manually copy and paste in the wiki (such as page Icons list 1.6)
- The pictures of the SVN can be automatically uploaded in the wiki using Upload SVN pictures into the wiki
[edit]
Help pages and images in the manual
- Jajuk manual pages from the wiki are converted to HTML using the script Converting Jajuk Manual wiki pages to raw HTML for JavaHelp. The script upload the pages into the SVN under doc/jajuk-hs/. Images for the manual are downloaded from the wiki and then uploaded in the doc/images section of the SVN
- A fresh SVN update is necessary to built the JavaHelp manual
- Finally, the JavaHelp manual is uploaded into the SVN
[edit]
