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 / Advocate for Community Documentation

May 11, 2010 by annegentle

Advocate for Community Documentation

“Anne, I see you as an advocate for community documentation” – what a great compliment. I was so pleased with the response to my STC Summit talk last week, Strategies for the Social Web for Documentation. Here’s the short description of the talk:

Let’s say that the most driven and driving developer on your team, who also happens to be a popular blogger, comes to you and asks why your end-user documentation doesn’t allow comments or ratings. Rather than stammering something about Wikipedia’s latest scandal, or reaching for imperfect responses that sound like lame excuses, do your homework and learn best practices from others who are implementing social web content that is conversational or based on community goals. Along the way you may realize there are good reasons not to implement a social media strategy, based on studying the potential community and time you’d spend in arbitration with community members on contentious issues, or you may discover that you can borrow from benefits of a single approach while still meeting business goals.

Objectives:

  1. Identify specific types of tools on the social web, such as tags, blogs, wikis.
  2. List risk areas and pitfalls.
  3. Identify writers’ roles with social media (instigator or enabler).
  4. Plan a strategy of listening, participating, building and then offering a platform or community.

I’ve also posted the slides on Slideshare for all to see and share with others.

STC 2010 Strategies for the Social Web for Documentation

View more presentations from Anne Gentle.

While talking to technical writers who are struggling to find the vocabulary to describe their new way of working in a content curator or community role, I got the sense that we’re all trying to reinvent our approach to traditional documentation. Coming together at a real-time, in-person event helped me focus my thinking and I appreciate all the dedication that went into the event.

Related

Filed Under: social media, wiki Tagged With: community, social, social media, STC, stc10, techcomm

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