For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

What's Convenient Gets Used -- a General Principle That Applies to Nearly Everything

by Tom Johnson on Sep 17, 2008
categories: technical-writing

Recently I switched from using the iRiver I bought two years ago to my wife's iPod Nano, which she only uses intermittently. I don't know why I used my iRiver for so long. The iPod is superior in every way, but mostly because it offers convenience. For example,

  • New podcasts download automatically when I merely plug it in to my computer and click Sync.
  • Its small size allows me to clip it onto my belt and easily hide the headphones in my pocket.
  • I can quickly toggle between music and podcasts.
  • When I stop a podcast half way in the middle, the iPod remembers where I left off the next time I return to it.

I have my BlackBerry clipped onto the left side of my belt and the iPod Nano clipped onto the right. Yes, it feels nerdy, but it's also extremely convenient. If I had to dig the iPod out of my backpack every time I wanted to listen to a podcast, or if I had to sit there every morning downloading podcasts, I'd be much less likely to listen. But by making podcasts extremely convenient, I plow through more episodes now than ever.

There's a lesson to learn here: Don't underestimate the importance of convenience. If you want to increase the usage of your help material, increase its convenience. Make your help context-sensitive. Provide a one-page quick reference guide. Give the user a search field that returns accurate results, etc. The long printed manual is going out of style not because it's ugly or long, but because it's inconvenient.

Sponsored

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.