Davyd Madeley: Documentation BoF
Jul. 10th, 2009 05:54 am![[personal profile]](https://www.dreamwidth.org/img/silk/identity/user.png){kind=small}
marnanelHow we're generating documentation in telepathy-doc.
There are three kinds of docs: facing developer (like a tutorial... what tool?), facing user ("how do I format my USB key"... Mallard), and the stuff you format from the API (gtk-doc).
Developer docs
HIG, GTK Drawing Manual, ... etc
Example code, descriptive prose, i18n, multi-programming-language examples (how??), link to the API references
telepathy-doc
DocBook, gnome-doc-tools, svg figures, and a ton of Python to play with the xml. DocBook purists don't like this (would rather do it in DocBook).
There are three kinds of docs: facing developer (like a tutorial... what tool?), facing user ("how do I format my USB key"... Mallard), and the stuff you format from the API (gtk-doc).
Developer docs
HIG, GTK Drawing Manual, ... etc
Example code, descriptive prose, i18n, multi-programming-language examples (how??), link to the API references
telepathy-doc
DocBook, gnome-doc-tools, svg figures, and a ton of Python to play with the xml. DocBook purists don't like this (would rather do it in DocBook).
