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 / talk.bmc / Best practices in technical communication for customer feedback

May 4, 2006 by annegentle

Best practices in technical communication for customer feedback

Many technical writers pride themselves in being customer advocates. What are some best practices for connecting with customers?

For another part of an informal series about best practices in technical publications, I want to discuss customer interaction with writers and getting customer feedback about your technical documentation. How can technical writers ensure they are making the right customer connections to best help a company succeed? A few of the best practices listed in the “Tech writers as sales reps?” that the panel referred to for our Austin STC Meeting in October 2005 that are related to customer interaction are:

#7: Encourage technical writers to meet customers.
#8: Use customer advisory boards to get feedback on documentation.

Q: Customer interaction – let’s discuss the constraints on really making this happen. How have you made it happen?

A: These managers had done a lot of things to get customer feedback, from customer surveys to online feedback forms embedded in the online help. Bill Hunter guest-blogged about online feedback forms previously .

All the manager panelists liked the concept of a customer advisory board, citing that as a great best practice. Also scheduling your writers to have lunch with customers when they’re on site for training is a great idea.

One manager said from her experience that she finally understood why it wasn’t always a good idea to have writers talking directly to customers, due to the issues that a writer may not be able to resolve to the customer’s satisfaction because the politics are out of their realm of expertise or influence. Also, our curious nature might lead us to ask questions about our own tools that might not have the best answer, leading to awkward, shoe-shuffling moments. So, in this manager’s perspective, she felt that writers should not meet directly with customers unless they are trained on how to work with customers and guide discussions so that you answer questions correctly or help with things that are fixable (and realize not all perceptions can be fixed). If you’ve worked in IT for any amount of time, you know about these perceptions and what can and can’t be fixed.

Getting customer feedback can be a best practice to put into place, but you may not always get an immediate positive result. You have to ensure that your doc team can succeed by setting expectations for the requests to avoid unrealistic requests based on time or resources available. Still, any time spent with customers helps us take a walk in their shoes and should offer both participants valuable insight into the other’s position.

This post continues the series about best practices in technical communication where I blogged about:

Questioning technical publications best practices

Best practices in tech comm for fit in the organization

How to implement a document or records management system that meets ISO standards

Related

Filed Under: talk.bmc Tagged With: customer support, ISO, technical communication, techpubs

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