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 / Reasons for moving towards a conversation, towards collaboration, towards the community

September 12, 2008 by annegentle

Reasons for moving towards a conversation, towards collaboration, towards the community

What if your user’s guide had to read like an Instant Messaging, or IM conversation – quick, real-time questions, fast answers, and tailored to nearly every potential customer situation? Harry Miller from Microsoft pondered this very question in a podcast in the mid-2000s.

Sometimes users expect precise answers from their user guide. When you work with a product, you want to be able to impress people with your knowledge and efficiency. Or, you have a particular aversion to truly learning a product that you have to use to do your job, but you only use the product once every other month to do a specific (perhaps boring) task. Your manual does not talk back to your users in either situation just yet. But the person who reads the entire manual cover to cover will have conversations in turn with the people to look to him as the expert in the office.

Even if your documentation system can’t “talk back” to your users, your documentation can help customers talk to each other and make the connections that help them do their jobs well, play at home with more fun, or learn something new in a classroom setting. I have ideas for how you can think about documentation and user assistance in a conversational way, perhaps with the help of some social media technology applications.

Now, there are plenty of good reasons for technical writers to avoid actual conversation with customers. We are not necessarily trained in diffusing an angry customer or in troubleshooting the product at the technical level that is necessary. But we are good at learning quickly and applying technology to solve problems. These are not skills left only to the young talkative type, the technically savvy geek, or the extreme extrovert.

You might think that the term social media or a buzzword comes up is that the technology is meant for young people only, or that you have to have a lot of spare time to appreciate things like social bookmarking or Second Life. But the reality is that communicators are already skilled with many of these technologies. We just have to be able to apply them to individual situations and build a business case if necessary.

Related

Filed Under: social media Tagged With: conversation, social, social media, social networking

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