Search results

Questions for making information discoverable as the user needs it

Questions for making information discoverable as the user needs it

  • How will users discover this information?
  • Is the topic SEO friendly for keywords that users would target?
  • Are there places in the UI (or in error messages, etc.) where we could link to the topic?
  • Could this be a related topic in other areas where users might end up, such as on other topics (as they follow the information scent in the docs)?
  • What metadata attributes should this information have (audience, location, operating system, device, language, etc.)? How can we map this metadata to the user to surface this content more naturally to the user’s context?

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, 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.