Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / social media / One community takeaway

March 9, 2010 by annegentle

One community takeaway

Here’s a question and answer writeup that I have had squirreled away for a while.

Q: You recently published a book entitled “Conversation and Community“. If you could pick just one thing from your book about interacting with the community, what would it be?

A: I actually blame Whurley and Michael Cote’ for getting me interested in open source communities and wikis for documentation! And by “blame” I mean “thank.” 🙂 The one thing I’d take away from my book about community is how educational my experiences volunteering as a technical writer for open source projects have been. I feel like I’ve taken a wiki apprenticeship by volunteering with FLOSS Manuals, writing free documentation for free software. I got my wiki feet wet writing for the kids, parents, and teachers using the One Laptop per Child hardware and SugarLabs education platform.

I found that I was interacting with community members and volunteers through the wiki infrastructure itself. For example, we all know how difficult it can be to open the OLPC XO laptop when you first see it closed up. I used an “Art Wanted” wiki page to request simple line drawings showing the opening of the “rabbit ear” latches in a simple step-by-step fashion. In a few weeks’ time, I had links to two images sent to me through my wiki “talk” page from a volunteer that show the two step process for opening the laptop very clearly. This kind of story amazes technical writers who have been working in enterprise environments where a graphic design request wouldn’t have that fast turnaround time.

I also learned that early interactions with people can lead to bigger collaboration opportunities, and that sometimes in-person collaboration is the most efficient. My favorite community event from that experience was the week-long Book Sprint we held in Austin in August 2008. We invited all sorts of recognized community contributors including Walter Bender, one of the founders of the MIT Media Lab. He had written one of the first comments on the discussion for the original simple users guide in the OLPC wiki, pointing out some outdated screenshots. His involvement and helpful attitude led to enormously productive writing sessions at the Book Sprint. Embracing the wiki for authoring led to great results.

Related

Filed Under: social media Tagged With: community documentation

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in