GNOME Docs Hackfest (Part I)


(A duck at Inglis Falls, in Owen Sound, Ontario, home of woscon09. If only it had been a mallard…)

Milo Casagrande, who attended woscon09 with the GNOME Docs team last week, has written an introduction to Mallard .

Milo and Phil spent Sunday’s hackfest creating the first Mallard document for use as a help file within an application. We chose Empathy, for a few different reasons, including: it will be in GNOME in 2.28; the current documentation is not completed; we want to re-license it from GFDL to CC BY-SA 3.0 and Milo and one other collaborator were the only ones who had worked on it previously (though we fulfill our obligations in re-licensing by the exercise below).

Using the information we learned Friday and Saturday, we spent time planning the document and brainstorming what users want a messaging application to do, and what questions they might have: “How do I….?”.

From there, and with great gusto, Phil and Milo spent the sprint creating a proof of concept help file for Empathy. Not only is it written in Mallard, which can dynamically link the pages, we are focusing on creating topic based help, rather than tasks that take a user step by step in performing an action. Phil and Milo will probably have words with me, but you can follow along on the empathy-mallard branch in Gitorious .

You will need Yelp 2.27.1 and gnome-doc-utils 0.17.1 to see a Mallard doc in Yelp. And now I have to go figure out why Yelp isn’t cooperating with me.

Paul Cutler
Father. Husband. Vinyl Music Lover. Football fan. Python student. He / him.