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 / Content tidbits from a Community Roundtable report

March 4, 2010 by annegentle

Content tidbits from a Community Roundtable report

Content tidbits from a Community Roundtable report

Photo courtesy M i x y on Flickr using the CC By 2.0 licenseI’m reading (with vigor!) the The State of Community Management Report: Best Practices from Community Practitioners
from the Community Roundtable
, and finding so many wonderful tips about content from people who are community managers. I had to start a list of items that are relevant to technical communication and web writing to share. I naturally tend to target technical communications when I interpret the report, but this report is rife with content strategy.

I agree with this statement, and I think it means a positive impact on technical writers and web writers who are paid to create content by businesses.

The percentage of content that is desirable and
feasible to be formally produced versus community-generated
will have a big impact on resource and
budget planning. This aspect is likely to change – often
dramatically – over time, although it should not be
assumed that content should ever be exclusively
community-generated.

I personally haven’t found that completely community-generated documentation will serve most business goals. In the case of FLOSS Manuals, though, the community-generated content meets the main purpose of supporting and documenting  open source software. Still, hiring professional writers makes sense when you need to create content that meets very specific goals for a community, whether your goals are raising awareness, troubleshooting, or learning.

Now, this particular comment puts a bit of a stake in the heart of technical communication’s beloved single sourcing. I like the idea of associated content for technical writers to create. It’s branching into new media, such as audio or video, while still valuing the technical content that you work so hard to create. It’s not that one births the other, but rather the two types can compliment each other.

Instead of directly repurposing content from one format to another, create
associated content. For example, instead of turning a white paper into an
audio transcript, create a podcast discussion about it with the author.

Another line that causes me to press pause and ponder for a bit:

People seldom form relationships with text alone.

Instead, offer images, video, or music as part of the user experience in order to grow relationships. Fascinating.

And finally, the one that might be the toughest for professional writers, copy editors, and technical communicators to accept:

Learn to accept imperfection. Concentrate on making content interesting
and relevant rather than perfect. Imperfection actually allows community
members to better relate to it and engage with it.

And with striving towards imperfection as my excuse, I’ll close out this blog entry and encourage you to read the report for yourself, drawing your own arrows from the quiver and targeting what is important to you.

Related

Filed Under: social media Tagged With: community, content, strategy

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