Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 3,881

Stitcher radio

follow us in feedly

Want more tech comm blogs to follow? See my Tech Comm Collection of Blogs on Feedly.

Adobe FrameMaker

Recording of my WTD Portland 2017 presentation on Building navigation for your doc site -- 5 best practices

Jun 8, 2017 • findability, podcasts

Here's the recording of the presentation I gave at the Write the Docs 2017 Portland conference. The presentation explores best practices for doc navigation, including principles such as hierarchy, modularity, progressive disclosure, entry point, and wayfinding. The presentation is about 20 minutes long, and you can either watch a video or listen to audio. Other WTD presentation recordings are also available.

Audio only

If you just want the audio, here it is:

Listen to this presentation:

You can also download the MP3 file, subscribe in iTunes, or listen with Stitcher.

Slides

Here are the slides:

Presentation description

Write the Docs 2017: Building navigation for your doc site: 5 best practices by Tom Johnson

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 — such as breadcrumbs and workflow maps — to help orient users as to where they are in a larger system.

More resources

To watch other Write the Docs 2017 Portland conferences videos, see the this playlist on the Write the Docs YouTube channel.

To learn more about the Portland Write the Docs conference, see writethedocs.org/conf/na/2017/.

If you missed my conference write-up, see Impressions from the Write the Docs Conference – and thoughts on achieving sustainability without selling out to vendors.

follow us in feedly


Get new posts delivered straight to your inbox.

Subscriber count: 3,881

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.