Docs Hackfest at Open Help 2013

The Open Help Conference organized each year in Cincinnati by Shaun McCance is a terrific environment for a docs hackfest. It’s always a great opportunity to hear and discuss ideas in help and documentation tools, and, thus inspired, write docs.

The conference. Standout presentations for me included an entertaining talk about Ask Ubuntu by Jorge Castro, Red Hat’s Rich Bowen on knowing your audience, and Mozilla’s Janet Swisher with tips for making doc sprints successful. Warren Block showcased FreeBSD documentation tools, and Steve Gordon demonstrated web-based procedures used at Red Hat. Shaun exposed the machinations responsible for making the Getting Started videos translatable.

The events. On opening night, Shaun hosted a winning reception at Via Vite on Fountain Square, complete with a live concert as a backdrop and the sounds of fireworks on the river. To add to the festive atmosphere, the Reds arranged a homestand. Monday brought bourbon tasting, a fascinating history lesson at Japp’s in historic Over-the-Rhine. This was followed by a 7-km march into Kentucky and back (crossing the Ohio River on two different bridges) for a dish called chili in some precincts.

reception

The city. The local cuisine dazzled us with its variety as we experienced Nada (Mexican), The Rookwood (steak dinner inside a pottery kiln), Tom + Chee (grilled cheese with anything), Izzy’s Deli, and a delicious last-morning coffee at Aquarius Star aka the Om Café (who also catered the fabulous organic conference lunches). We went for seconds of ice cream and chili; at Skyline the intrepid among us wore bibs for the photographs.

aquarius

The sprint. Ryan Lortie embarked on a new strategy, HowDoI?, a daring DIY documentation departure for developers – here’s the page for GtkApplication. The rest of us brainstormed and wrote content for the devel-docs module with Shaun leading the process, giving the Platform page another facelift and tweaking the code. We built on work done earlier this year by the DX team in Brussels and the docs team in Brno, as well as previous years’ work by Phil, Tiffany and a small army of OPW interns. (My earliest experience of GNOME3-era devel docs was Johannes and Germán cranking out pages in Toronto). It will be great to see a combined effort at GUADEC.

hackfest

The highlights. We organized an evening of discussion, laptop resuscitation and pizza around Dave & Kat’s wonderful gift of Kentish ale. Jim and I caught a couple of periods of Stanley Cup hockey as his team tangled with Boston in a rare Original Six final. Best of all was getting my son Gord involved with GNOME, as he got a chance to learn the ropes, and filled in for the absent interns.

Thanks to Shaun McCance and Syllogist for organizing a sensational conference, and sponsors Mozilla, WordPress, GitHub and Red Hat. Thank you also to the Foundation for sponsoring my travel and accommodation.

sponsored-badge-simple

5 thoughts on “Docs Hackfest at Open Help 2013

  1. Dylan McCall

    OMG, these HowDoI doc pages are great! The ones I’ve looked at are very helpful and straight-forward :)

    Is there a document somewhere that explains how they should be written? I’d love to see more of them in the future.

    Reply
    1. mdhill Post author

      Thanks, Dylan. Ryan indicated that he’d like to do a How Do I HowDoI page at some point, but here’s his quick take on it…

      I’ve thought of HowDoI as being based on three principles
      1) “I’m new to this. give me the overview of how it works”
      2) even people experienced with the technology should walk away from it feeling like they’ve learnt something
      3) heavy on examples, including code samples
      Some sort of mix of those three things is what I aim for.

      Check out the one Ryan added today:
      https://wiki.gnome.org/HowDoI/DBusApplicationLaunching

      Reply
  2. shobha

    In the blog OpenStack Rhône-Alpes Meet-up #1, people there I feel enjoyed more :)
    yummy Open Stack cake…hmmm

    Reply

Comments are closed.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>