Views

Documentation Manager Guide

Share |

Contents

Description

Workspace of: Documentation Manager
Browse this workspace
Browse other Workspaces
Members Corner
Contacts
Contact us
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.


Note : after bad experiences with unmaintened multi-language manuals, we decided for now to concentrate only on the English version of the Jajuk manual. Please don't try to create a translated version, we don't have the workforce to handle it.


Detailed roles

  • Making sure the English 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
  • 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...)

Required skills

  • 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

Managing documentation and images in Jajuk

The list of icons 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)

See also