08 May 08: Summer of Doc, anyone?

Now in its fourth year, Google Summer of Code supports students in writing code for participating open-source projects, which provide mentors to help guide the students' work. Thanks to Google's sponsorship, the students receive a stipend (making this a summer job), and mentors receive a nominal compensation for their time.

From the GSoC FAQ:
What are the goals of this program?

Google Summer of Code has several goals:
  • Get more open source code created and released for the benefit of all;

  • Inspire young developers to begin participating in open source development;

  • Help open source projects identify and bring in new developers and committers;

  • Provide students in Computer Science and related fields the opportunity to do work related to their academic pursuits (think "flip bits, not burgers");

  • Give students more exposure to real-world software development scenarios (e.g., distributed development, software licensing questions, mailing-list etiquette).


If you substitute code/documentation, developers/tech writers, Computer Science/Technical Communication, I think it's fairly obvious that the same benefits could apply to Tech Comm students writing documentation for open source projects.

Members of the user experience community have started an analogous effort called Season of Usability. It's time to do the same for technical communication in open source.

The February 2008 issue of Technical Communication included an article by Dave Yeats on "The Role for Technical Communicators in Open-source Software Development". (You can read it online if you are an STC member.) He gives an excellent explanation and history of the open-source movement, and describes why it is not quite as user-centered as it claims to be. He argues that the best value that technical communicators can offer to open-source projects is not more documentation, but user-advocacy:
Rather than offering to write procedural information for individual projects, technical communicators could use their abilities in user analysis to help developers better understand their target audience and the importance of usability in software. While documentation may offer workarounds and help users navigate unwieldy interfaces, open source would benefit even more if those interfaces were made more intuitive so that the documentation wasn't necessary.

I agree that would be great. The trouble is, I don't see technical communicators lining up in droves to participate in open-source projects at all. I've noted the few I know about.

On the other hand, technical communication students need projects, and they need work products to add to their portfolios if they hope to get a job in this field. Yeats's article mentions the Open Source Development and Documentation Project at Purdue University, which integrates open-source software into technical communication courses. That's cool. (Unfortunately, their website appears to be down as I write this.) However, what if your institution doesn't have program like this? What can a student or instructor do on their own?

That's why I think there is a need for a "Summer of Doc". Or, a "Season of Doc", because it doesn't have to be in the summer, and it doesn't have to be just three months. The word geek in me wants to call it "Period of Doc", just for the cheap punctuation pun, but the user advocate recognizes that that won't make sense to many people.

What do you think? Anybody want to help?


Category: Open Source | Posted by: jmswisher

Comments

06 Jun 08, 06:35:42 Anne Gentle wrote:

Hi Janet - Floss Manuals has this sort of opportunity for students and practitioners alike, and sometimes it's even a fully funded trip so that a team can locate together for an intense in-person team effort.

We're hoping to get one together for the OLPC manual some day, so I'll keep you posted. Floss Manuals (Adam Hyde) did approach someone (Google?) with the idea, and I don't remember what the outcome was, other than it might not have been a big enough project to meet their criteria, although they were certainly open to the idea. I'll email Adam so he can jog my memory about what exactly he had asked for, and what the exact response was. :)

07 Jun 08, 16:02:42 Janet Swisher wrote:

Hi Anne,

It may be that one project isn't enough to interest Google, but if several projects coordinated, it might be. That seems to be the case with "Season of Usability". I emailed their coordinator, asking how they got started, but haven't heard back.

08 Jul 08, 07:00:27 Anne Gentle wrote:

Hi again Janet! I wanted to point to an Inkscape doc sprint going on now in Paris. Go to http://en.flossmanuals.net/... and click the Blog link, the top entry has a picture of the doc sprint. Cool!

I'm actively recruiting writers for a doc sprint on the OLPC and Sugar documentation for the XO laptop - interested? Let me know. :)

31 Jul 08, 07:39:09 Anne Gentle wrote:

Just wanted to point any readers of this entry to find out more about the XO/Sugar BookSprint in Austin this summer:
http://justwriteclick.com/2...

Thanks for this blog entry.

20 Aug 08, 08:14:13 adam wrote:

hi,
Yip Google supported FLOSS Manuals to bring together an Inkscape Book Sprint. We held it in Paris and it was fantastically productive :)

Anne is working busily on the OLPC/Sugar sprint now and its shaping up very nicely.

adam

Add Comment

This item is closed, it's not possible to add new comments to it or to vote on it