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 / writing / Words are it… from 17 words to topics

November 27, 2007 by annegentle

Words are it… from 17 words to topics

I say I don’t listen to many podcasts, but I’m currently listening to Design Critique’s podcast with Gerry McGovern at the User Interface 12 conference. Timothy Keirnan was a MTSC classmate of mine and does an excellent job interviewing usability professionals for us all to learn from.

One of Gerry’s comments that really hit home to me is that Google’s entire ad revenue generation is based on 17-word ads. Seventeen words! I complain about the 140-character limit in Twitter, yet, lots of money is being made on seventeen words.

Also, they both noted that generally, web site design is so flat – rectangles and boxes are pretty much all you get. So websites should be useful and functional. And words matter. For example, if you are a non-native English speaker approaching a website for information, you’ll be more successful by recognizing the word “search” quite quickly.

I was also reminded of Harry Miller’s podcast, The IM Model of Technical Writing, about writing end-user documentation as if you were responding to a friend’s Instant Message (IM). Topic-oriented writing such as DITA encourages you to encompass ideas in discrete bundles – topics contain only as much information as is needed. From the specification: “A topic is a unit of information with a title and content, short enough to be specific to a single subject or answer a single question, but long enough to make sense on its own and be authored as a unit.” Very IM-like, I’d say.

An enjoyable couple of podcasts, and quite appropriate for my current thoughts about the value of good writing along with good design.

Related

Filed Under: writing Tagged With: DITA, IM, podcast, technical writing, topics, twitter, usability

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