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 / techpubs / Crowdsourcing Inquisition

May 17, 2011 by annegentle

Crowdsourcing Inquisition

Crowdsourcing Inquisition

I consider myself a curious person. I was constantly questioning as a kid, much to the chagrin of my fifth grade teacher. I recall that he wrote in my yearbook, “Keep asking questions, but when you ask, listen and learn.” How fortunate I could become a professional technical writer, where curiosity and asking “how does that work?” is a requirement of my daily work. Of course, the listen and learn portion for my 30+-year-old self is, “write it down before you forget!”

What’s nice about working on OpenStack at such an early stage is that others are asking really good questions also. We started the project using Launchpad’s Answers feature for OpenStack projects. Launchpad Answers is a rudimentary question and answer system that’s a blend of a mailing list and a forum in one, attempting to help projects create community support sites. (We all know that building a community support site is about people, not tools, so I’ll just repeat that mantra here for emphasis, people over tools.)

With configurable notifications and the ability to turn a question into a bug, it acts as a substitute for overly-eager users filing tons of non-vetted bugs. I don’t find it as advanced in the community equity model as say, Stack Overflow’s Q&A sites, but you do earn “karma points” for answering questions, and you can comment on a question or ask for more information. Also, the person asking seems to have the upper hand for marking a question as answered. We’ve very recently started to explore the use of a forum rather than the Launchpad Answers area. I’m hoping we’ll see as much curiosity in the forums as we have seen in Launchpad Answers.

To me, the upsurge in community support sites means that the questioning nature of a technical writer can be spread out among even more questioners. Even if a user does not consider themselves to be technical writers, they are doing some of the work of a technical writer. People in the real world, trying out OpenStack, are coming back with all sorts of questions. Plus, the questions and answers can be searched for later reference. It’s a gold mine of technical info and specific scenarios. The challenge for the technical writer is to sift through the questions and answers and determine relevance for their audience and determine the majority use, eliminating edge cases. The challenge for the system itself is

And in the theme of yearbook quotes, how about this one? “Better ask twice than lose your way once.” My hope for OpenStack is to build a community support site where duplicate questions are not dinged but search-worthy, there are no dumb questions, and the questioners listen and learn, and then pay it forward.

Related

Filed Under: techpubs, tools, writing Tagged With: answers, crowdsourcing, openstack, questions, techpubs, writing

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