The event has some great speakers lined up, with speakers from Mozilla, Red Hat, BSD, GE, and others. Scott Nesbitt from DMN Communications will also be here. I’m looking forward to interacting with everyone, and am especially looking forward to talking shop with Anne Gentle. Anne works as the “Content Stacker” (aka documentation lead) for OpenStack. OpenStack shares our Launchpad infrastructure, so it will be great to find ways to collaborate with her and the other OpenStack doc contributors.

I will provide a few updates on the conference over the weekend on my blog, but you can also get some updates by following the #openhelp hashtag on both twitter and identi.ca.

I’m looking forward to a great weekend.

My week at UDS was a challenging week. A great week. A week in which I had great discussions around docs, met lots of cool people, and wound up expanding the limits of what are normally considered acceptable sleep patterns.

I had three docs-team sessions during the week. I also attended two sessions about cloud-related documentation, and another session on server documentation. The three docs-team sessions focused on the team strategy, our goals for the 11.10 release cycle, and evaluating a web-based documentation platform.

Team Strategy

The inspiration for the team strategy discussion is the Xubuntu Strategy Document. Have you read it? When Cody Somerville first wrote it, part of me was like, “Are you serious? Did you write this yourself?” It seemed too complicated. In practice, though, I’ve seen the Xubuntu team reference that document while making decisions time and time again. I think a similar document would benefit the docs team, too. I’m preparing a draft document based off of recent team discussions, and will be sharing it in the next week.

Team Goals for the 11.10 Release

The team goals session was pretty great. People in the room, and people listening in via the audio casts, gave helpful input. There was more focus on the Ubuntu wiki at UDS than I anticipated. Some of our goals for this cycle include creating a strategy document, contributing to upstream docs projects, refactoring our team wiki, testing of documentation accessibility, testing a preferred help layout, doing stable release updates for docs and translations, squashing boogs, adopting a consistent coding style, updating our style guide (or picking an existing one), and doing some of the initial work in revamping help.ubuntu.com.

It sounds like a lot, and it is, but some of it is already a work in progress. We will make these goals explicit during our next team meeting.

Web-based Documentation Platform

The group behind this project is Pronovix, a Drupal consultancy. I knew that their project was using Drupal and DITA, but I wasn’t sure what *their project did*. They had some of their staff based in Hungary, just a short trip away from Budapest, so I thought it was worth getting in touch to learn more about their approach and how it might benefit us.

DITA stands for the Darwin Information Typing Architecture, an XML syntax developed by IBM that specializes in content profiling and content reuse. The advantage of content reuse with a tool like DITA is that it allows you to write something once, write it well, and reuse it most everywhere. That is the idea, at least. Implementation of DITA can be difficult. Their project has promise, but the toolchain isn’t currently packaged by any distro other than OpenSUSE. Harald Sitter (Mr. Apache Log File) felt that this very much limits the likelihood of upstream adoption.

Even with that in mind, we are going to seriously evaluate their platform. It was very considerate of this group to make a trip to demonstrate their project, and we want to be supportive of everyone who is working in open source documentation.

There are quite a few irons in our fire, and we’ll have to get word out about our activities somehow. Our progress will likely be presented via a new Ubuntu Documentation Team blog. We think now is a good time to start one up, so look for more info on that soon, as well.

The guide also includes a link to a “color quiz” where you can get an idea of how well you know the meaning of colors in the U.S.  Unfortunately, I only got a little more than half of the answers correct.  : (

Thanks to Rhonda Bracey of the Cybertext Newsletter for sharing this on her own blog.

McCloud’s talk was interesting in a number of ways, but one aspect of it that struck me was the volume of work went into what he did.  The initial basis of the work was 10 dvd’s worth of recorded interviews with developers.  They did not allow the content of the comic book form to be dictated by some kind of marketing storyline.  The comic still stood up as a form of documentation.

Additionally:
* The use of bubbles as text-placeholders in the comic created some difficulties for translators, but they were able to make things work. He didn’t provide a great amount of detail about this.
* He loved the mash-ups that resulted from the work being licensed under a Creative Commons license, even if the mash-ups didn’t follow the letter of the license.  Google did not attempt to sue people who made these mashups for noncompliance with the license.
* He demonstrated how comic book framing can keep the use focused on one item at a time, and make it easier to explain difficult concepts in an elegant, easy-to-understand way.
* I think he referenced XKCD at least 3 times.  He likes it.
* I can’t draw comics.  :/  Maybe I can use some of this stuff with screenshots, though.

I also attended a session on ISO standards for documentation and D.I.T.A., an open-source documentation toolkit similar to docbook.  The standard is maintained by OASIS, a not-for-profit standards organization – it looks great!  We got to see snippets of it, but it costs about $200 to get a single copy of the standard. :/  Even members of the OASIS committee who volunteer to maintain the standard have to pay to get a copy of it.  I am glad that at I don’t have to pay to contribute to Ubuntu.

The best session of the day for me was the session on architecting documentation for reuse.  The Ubuntu documentation team already has some of our content architected for reuse; for example, we use docbook “entities” for repetitive items such as system and software version numbers, Ubuntu website urls and certain procedures, but this showed how it’s possible to do more.  I’m a little green as a member of the Ubuntu documentation team, but I’m eager to learn more about this approach.

1) http://www.debian.org/doc/devel-manuals#policy
2) http://www.debian.org/doc/devel-manuals#devref
3) http://www.debian.org/doc/devel-manuals#maint-guide
4) https://wiki.kubuntu.org/PackagingGuide
5) https://wiki.kubuntu.org/PbuilderHowto
6) https://wiki.kubuntu.org/PackagingGuide/Lists/DocumentationResources

He sent them out to the mailing list in advance of a packaging session that’s being held this Sunday at the College of DuPage, in Glen Ellyn, Illinois.

I’m not sure how much we’ll be able to cram into our session that day, but it should be a good start for those of us who aren’t familiar with packaging at all.  As someone who has primarily been focused on assisting with documentation, hopefully some day I’ll at least know how to package the set of docs that we create.