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

How To Create a Usable Index — Interview with John McGhie

by Tom Johnson on Oct 20, 2006
categories: podcasts

Listen here:

John McGhie, technical writer and Microsoft MVP from Sydney, Australia, explains how to create a usable index for your help material.

In this interview, John covers the following topics:

  • Deciding whether to create an index
  • Skills required to create an index
  • Steps in creating an index
  • Audience considerations in creating an index
  • Time required for creating an index
  • Pitfalls writers face when creating an index
  • Myths of the concordance file method for creating indexes
  • Strategies for entries and subentries
  • Methods for updating an index
  • Determining whether your index is usable

Sponsored

For additional information, see the following:

** To contact John, you can e-mail him at [email protected].

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.