Building navigation for your doc site: 5 best practices

Description

Although users typically arrive at doc websites in a confused and impatient state, not sure of where to find what they're looking for, good navigation can guide them to the right answer. Good navigation anticipates users' needs, provides links in commonly viewed places, and brings the right topic into the foreground amid hundreds of other topics.

As you build out the navigation for your doc site, follow these 5 design principles:

  • Entry point. Design the entry point to your system to orient users and allow them to easily get started.

  • Hierarchy. Create a hierarchical outline of the content to help users both understand and visualize the body of information.

  • Modularity. Break up content into independent topics that can be viewed, understood, and updated independent of the whole.

  • Progressive disclosure. Layer the information so that you don't present everything at once but rather make some content available only at secondary or tertiary levels.

  • Wayfinding. Provide navigational signposts \u2014 such as breadcrumbs and workflow maps \u2014 to help orient users as to where they are in a larger system.

  • Conference: Write the Docs NA
  • Year: 2017

About the speaker

Tom Johnson