How To Create a Usable Index — Interview with John McGhie
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
For additional information, see the following:
- John McGhie's bio
- John's helpful article on indexing that I mention in the podcast
- The Word MVP home page
** To contact John, you can e-mail him at [email protected].
About 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, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.