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 / techpubs / Playing with the Future of Technical Communication

April 23, 2011 by annegentle

Playing with the Future of Technical Communication

Playing with the Future of Technical Communication

I have a great group of mom friends who also happen to be technical communicators. One day last month, my friend posted this picture her 6-year-old daughter made and asked if technical writing is genetic. Ha!

The first 12 steps for making a dinosaur of Play-Doh

Her mom says, “These are her first 12 steps of 20 that show how to make a Play-Doh apatosaurus.” You may know the apatosaurus as the brontosaurus.

This elementary-school student definitely “gets” that the future of tech comm is in pictures. She knows her audience – likely a non-reading audience that can recognize numerals. Plus she starts at the very beginning, piecing the steps and not making any assumptions. She even shows how to pop the top off the container of Play-Doh.

I loved this illustration and just had to share. I got permission from the copyright holder through her legal representative, her mom. 🙂 Thanks to both of you for sharing your talents!

So, how do we learn how to get the steps right? One educational exercise I’ve learned to demonstrate technical communication is to have students write out instructions for how to prepare a bowl of ice cream. You can have students write and illustrate the steps, and then exchange instructions to test the quality of the steps. Ice cream may never land in a bowl, or there may be no scoop tool, but it sure is fun to take a task and put it into the smallest self-contained step that you can. Students learn quickly that you should write down prerequisites and ensure your assumptions about the starting point match the end-users concept of the start point. I find myself coaching technical writing now that I work with a volunteer writing group. I wonder if I can run an ice cream demo at one of the doc sprints sometime. What are some other coaching ideas for technical writers?

 

Related

Filed Under: techpubs, work, writing Tagged With: design, education, future, graphics, illustration, instructions, kids, steps, techcomm, technical communication, technical writing, 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