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 / How can we go towards documentation as conversation?

August 20, 2008 by annegentle

How can we go towards documentation as conversation?

Tell me… and I will forget. Show me… and I will remember. Involve me… and I will understand.
-Confucius

Documentation as conversation means getting closer to the users and helping them perform well. Over the years experts such as JoAnn Hackos and Jared Spool have told us that this type of user-centered design and focus increases the quality of documentation.

H. Allen Brizee and Katy A. Schmaling wrote “Effective Workplace Writing” as a resource for the Purdue University Online Writing Lab (OWL), and they say “In the last twenty years, two important ideas have developed that help professionals compose effective workplace writing: rhetorical awareness, and user-centered design.” In my mind and from what I read, user-centered design is consistently related to Web 2.0 definitions. Where Web 1.0 merely served information blindly, Web 2.0 gives users a chance to interact with the information and each other using the web.

Taking off from the concept of user-center design, I’d like to talk about how to get even closer with real customers by starting conversations and enabling user assistance in interactions with users with a series of blog entries on documentation, conversation, and community.

Professional writers have more conversation-starting tools at their disposal than any other time in history. Techniques may include the use of blogs, wikis, forums, and social networking sites, but may also involve photos, simple stick figure illustrations, videos, virtual worlds, or instant messaging. What are your thoughts on a blog series to discuss modern methods for involving readers in the conversation surrounding technical documentation?

Related

Filed Under: social media, techpubs, tools, work, writing Tagged With: collaboration, community, conversation, writing

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