Skip to content. Skip to navigation

Ian Lawrence

Personal tools
You are here: Home Blog Ubuntu Mobile and Embedded (UME) Documentation

Ubuntu Mobile and Embedded (UME) Documentation

The best documentation system I have seen these last days is the one developed for the Django book

Formally launched in Spain, the
Ubuntu Mobile and Embedded (UME)
project has opened the way for new
developers to join the project.

For this to happen UME documentation
has to be of a really high standard.
Experience with some of the maemo
documentation has left something to
be desired, so in this spirit I had a think
about what could be done.

The best documentation system I
have seen these last days is the one
developed for the Django book. This
works on a 'many eyeballs' testing
approach using a contextual comment
system to help gather targeted
feedback about the documentation.

Instead of commenting on an entire
chapter, you can leave comments on
any individual "block" in the chapter.
After some time the docs are 'frozen'
and the best comments incorporated
into the main documentation. This
process continues until the final
documentation freeze before release.

This type of innovative approach to
documentation has been extremely
well received by the Django developer

The site they used is basically a front
end on python docutils and
reStructuredText using Ajax/jQuery.
I had a play over the weekend and
installed a similar beta system here
and replicated the compilation &
installation of the Hildon
Desktop Portability Documentation
a test to see how it works. I like it and
will use it some more.

The UME project and links to the code
and technical specifications can be
found at

Monday, June 11, 2007 in CodeThoughts  | Permalink |  Comments (0)   Digg   Yahoo   Google   Spurl
« August 2020 »
Su Mo Tu We Th Fr Sa
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31
Borala (4)
Bricolabs (12)
Code (57)
Estudiolivre (12)
Life (26)
MetaReciclagem (9)
Thoughts (16)
Work (41)