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 / Finding and following conversations – applicable for technical writers?

May 22, 2008 by annegentle

Finding and following conversations – applicable for technical writers?

Bryan has the following ideas for finding and following conversations, and I think these are quite applicable to our role as technical writer also. The only item I find wanting in his post is – what keywords do you use? My initial ideas are: product name, keywords for the problems and solutions that your product addresses, and company name. Perhaps even the job titles for people who use your product like I’ve blogged about previously.

Finding and following conversations

  1. Search on Google Blog Search
  2. Search on Technorati
  3. Use an RSS reader such as Google Reader
  4. Start subscribing and listening to podcasts through iTunes
  5. Subscribe to Google Alerts
  6. Reading blog comments
  7. Jump onto Twitter and establish a presence in Facebook

I found an excellent case study of technical writers engaging in conversation through Dee Elling, who is the tech pubs manager for a programmer’s IDE. She has a blog post called Help on Help where she gets lots of comments from users – some of whom are in her camp, others who are ready to go to battle for the help content, namely the code examples that had mysteriously disappeared between releases.

Dee answers honestly and really empathizes with their need for those examples, and has a plan in place for replacing them. Her blog post is a great case study for how to have ongoing conversations with your customers.

I’ve been thinking about the writer’s interaction with customers a lot lately, because of blogging and podcasting and wikis other social media pursuits that seem to lead us towards documentation as a conversation with customers. As Tom Johnson found in his Web 2.0 experiment, some users think that the help system has boundaries. How can we break down those boundaries (seems like search is part of the answer)? How could Tom have ensured that his customer sought out conversation rather than answers?

Related

Filed Under: social media Tagged With: blog, blogging, borland, codegear, conversation, search, social media, web2.0

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