Start by understanding your users and product
Before organizing pages, align with the people who know your product and users best.Map the foundation with stakeholders
Talk with founders, product managers, and engineering leads before making structural decisions. The goal is to understand how the product actually works, not just how it’s marketed. Questions to ask:- What’s the simplest way to explain how the product works?
- What are the product’s core building blocks?
- How do users typically adopt the product? Where do they most often get stuck?
- What are the most important integrations or dependencies?
- If the product was broken into different layers, what would they be? Would it be organized by tasks people perform or by features they use?
Know who you’re writing for
Navigation decisions depend on your audience. A developer integrating an API navigates differently than an admin configuring settings or a new user following an onboarding flow. If you have multiple distinct audiences, consider whether they need separate navigation structures or whether a single unified structure can serve them all. See Understand your audience for more on defining documentation personas.Choose a navigation structure
Organize by user journey, not product features
The most common navigation mistake is organizing docs the way the product team thinks about the product instead of the way users try to accomplish goals. Compare these two approaches for an API product:| Feature-centric (avoid) | Journey-centric (better) |
|---|---|
| Core API | Get started |
| Authentication | Authenticate |
| Webhooks | Send your first request |
| Rate limiting | Handle errors |
| SDKs | Go to production |
Manage depth and breadth
Navigation depth refers to how many levels users must click through to reach content. Breadth refers to how many items appear at each level. A few principles:- Keep top-level sections to seven or fewer items. Cognitive load increases as users need to scan and evaluate more options.
- Prefer depth over breadth. A top-level section with five subsections is easier to scan than 20 top-level items.
- Don’t hide critical content below two levels. If users must click through three levels to reach frequently needed pages, consider promoting that content.
Name navigation items clearly
Navigation labels should match how users describe their goals, not how engineers describe features.- Use verbs for task-oriented sections (“Authenticate,” “Deploy,” “Monitor”)
- Use nouns for reference sections (“API reference,” “SDKs,” “Changelog”)
- Avoid internal terminology users won’t recognize
- Keep labels short—ideally under 4 words
Validate your assumptions
Your first navigation structure is a hypothesis. Validate it before treating it as permanent.Track real user journeys
Use session replay tools like FullStory or Hotjar and analytics tools like Mixpanel to study how users actually move through your docs. Look for:- Entry points: Where do users start? Are they coming from search, a support ticket, or directly from your product?
- Navigation patterns: Do users follow the expected structure, or do they take unexpected paths?
- Friction points: Where do users pause, loop back, or abandon their session?
- Search behavior: Are users searching for terms that don’t appear in your navigation labels? This signals a terminology mismatch.
Test with real users
Analytics surface patterns, but direct conversations provide the context behind them. Ask users to complete a specific task using only the documentation while narrating their thought process. Where they click first and where they get stuck reveals whether your navigation is intuitive. New hires on your own team make good proxies for users. Before they get too familiar with the product from the inside, ask them to find answers to specific questions using only the docs. Their instincts reveal assumptions your navigation makes that aren’t obvious to newcomers.Identify and fix common problems
Overloaded top-level sections
If your top-level navigation has more than 7 or 8 items, users spend more time evaluating options than finding content. Group related topics into sections with meaningful names.Buried essential content
If the pages users need most are two or three levels deep, promote them. High-traffic pages should be easy to reach from the top level or visible in the first level of any relevant section.Unclear section names
If users hesitate before clicking a navigation item, the label isn’t doing its job. Test whether users can predict what they’ll find before clicking by describing what’s inside.Missing pages vs. navigation problems
Sometimes what looks like a navigation problem is actually a content gap. If users search for terms that don’t match any page, you may be missing content rather than mislabeling it. Distinguish between the two before restructuring.Iterate over time
Navigation should evolve with your product and your users. You don’t need to get it right on the first attempt. A practical cadence:- Review navigation whenever the product ships major changes. New features often expose structural gaps.
- Check search analytics quarterly for terms users search that aren’t reflected in your navigation labels.
- Revisit top-level structure annually. As docs grow, what worked at 20 pages may not work at 200.
Frequently asked questions
Should I organize navigation by product features or user goals?
Should I organize navigation by product features or user goals?
How many top-level navigation sections should I have?
How many top-level navigation sections should I have?
How do I handle documentation that serves multiple audiences?
How do I handle documentation that serves multiple audiences?
First, decide whether your audiences are different enough to need separate structures. If an admin and a developer both need to get started, a shared “Get started” section may work fine with audience-specific subsections. If their journeys are fundamentally different—separate products, separate personas—consider separate documentation sites or tab-based navigation that clearly separates the two paths.
When should I reorganize my navigation?
When should I reorganize my navigation?
How do I prevent navigation from getting messy as docs grow?
How do I prevent navigation from getting messy as docs grow?