Documentation proposal

Jérôme Guelfucci jerome.guelfucci at gmail.com
Tue May 5 18:22:31 CEST 2009


I think we should really go for asciidoc or restructured text/sphinx, 
they are both far easier to use than docbook while still provide a 
confortable level of customization.

For the workflow, I think a mix of the different proposed ideas would be 
cool: we could have a separate component for docs; before every release, 
we copy the docs to each of the of the documented components (we could 
possibly have a hook which always make the docs available in every 
component).

As stated before, po files do not seem to be very helpful when 
translating documentation. This is all the more true with rest or 
asciidoc where the markup is minimal. To keep translations uptodate, we 
could have a translation page on the Xfce wiki (one per component maybe, 
with a main page) which lists the languages and the components. Every 
time we update the documentation or every time a translation is updated, 
we would update the status on this page.

That does not sound too complex, we could also have some people 
responsible for documentation who would send a few mails from time to 
time to remind people that things need to be updated.

Cheers,

jérôme



More information about the Xfce4-dev mailing list