Printer-friendly version

Author(s): Davyd Madeley

Free software is oft panned for its lack of really good developer documentation. The Telepathy project has been trying to rectify this by producing truly awesome and comprehensive documentation.

We are doing this using standard GNOME tools, including Docbook, gnome-doc-utils, xml2po and Python, but we're doing things like support for fully working examples, syntax highlighting, and automatic cross-referencing to API references, to improve the experience for the reader and the ease of development for the author.

The workshop will consist of a short presentation on how telepathy-doc works followed by discussion on how these tools can be adapted to other documentation projects and how the authoring and quality of developer documentation can be improved throughout the free-software world.

Author bio: Collabora

Davyd Madeley is a ninja hacker for Collabora Ltd. who has contributed to a number of free software projects, mostly within the GNOME community. Davyd's interests outside of computing include photography, swing dancing, playing the tenor saxophone and writing paragraphs entirely devoid of pronouns.