Skip to main content

Information architecture for SaaS docs that grow

· 7 min read
Documentation studio

Documentation information architecture usually starts as a sensible list of sections that matched the product on the day someone created it. Then the product grows: a second product line, an enterprise plan, a mobile app, an acquisition, three reorganizations. Each change adds a section or a subsection wherever it fits least badly, and a few years later the navigation is a fossil record of the company's history rather than a map of what customers need to do.

This post is about designing information architecture, or IA, that bends instead of breaking when that growth happens. It is the site-level companion to why documentation structure beats writing style, which covers structure at the level of a single page.

Signs your IA has been outgrown​

You rarely decide that your IA is broken. You notice symptoms:

  • The navigation mirrors the org chart. Sections are named after teams ("Platform", "Growth", "Core") rather than things customers do.
  • There is an "Advanced" or "Other" section, and it keeps growing, because nobody could decide where new content belonged.
  • The same feature has two names in different sections, because two teams documented it at different times.
  • Search has become the navigation. Readers, and your support agents, have given up browsing and search for everything.
  • New pages take a meeting. Every new article triggers a discussion about where it goes.

If three of those are true, patching the sidebar again will not help. The IA needs to be designed deliberately.

Choose one primary axis​

Every documentation site organizes content along some axis, whether anyone chose it or not. The common ones:

AxisExample top levelWorks well when
Product areaBilling, Reports, Integrations, AdminProduct areas are stable and customers know their names
Task or jobGet started, Invite your team, Automate reportsThe product is used for a few well-defined jobs
AudienceAdmins, End users, DevelopersAudiences need genuinely different content
LifecycleEvaluate, Set up, Use, TroubleshootOnboarding is the dominant reason people read docs

The mistake is to mix axes at the top level. A sidebar with "Getting started", "Billing", "For developers" and "Troubleshooting" side by side uses four axes at once, so a reader cannot predict whether a troubleshooting article about billing webhooks lives under Billing, Developers or Troubleshooting. Usually the answer is "all three, slightly different".

Pick one primary axis for the navigation, usually product area for SaaS help centers, because it is the one both customers and support agents already use. Then express the other axes through landing pages, filters and metadata rather than through the sidebar. A "Getting started" landing page can link into five product areas without owning any of their pages. The handbook page on navigation models compares these options in more depth.

Settle the vocabulary before the structure​

An IA is only as stable as the words in it. If the product calls something a "workspace" in the UI, "account" in billing, "tenant" in the API and "organization" in the sales deck, no navigation can make that coherent.

IA checkpoint

If two teams describe the same feature with different terms, your IA needs a controlled vocabulary before it needs a new sidebar.

A controlled vocabulary is simply an agreed list of the product's core nouns, with one preferred term for each, its definition and the synonyms customers use. It does not need a tool. A table in the docs repository works, as long as reviewers cite it and the terms appear in section names, page titles and UI labels consistently. The handbook page on naming and vocabulary covers how to enforce it in CI so terms stop drifting.

The synonyms column matters as much as the preferred term. Customers will search with the words they know. Mapping those words to your terms, in search configuration and in page text, is how a strict vocabulary still meets people where they are.

Keep URLs independent of the navigation​

The navigation will change; your URLs should not have to. The most expensive IA mistakes we clean up are URLs that encode the org chart or the current sidebar, such as a path that includes the name of a team that no longer exists.

A few rules keep URLs stable through IA changes:

  • Base paths on the thing, not the team. A path about billing invoices should mention billing and invoices.
  • Keep paths shallow. Two levels below the root is enough for most help centers. Deep paths break every time a level is reorganized.
  • Never put dates, versions or internal codes in paths unless the page is genuinely about that version.
  • Change a URL only with a redirect, and track redirects in the repository so the history survives.

Use metadata for the axes you did not choose​

Once you have one primary axis in the navigation, the others become metadata on each page: audience, plan tier, platform, product area, lifecycle stage. Metadata costs a few lines of front matter per page and pays off in several ways. It powers landing pages and filtered lists. It lets search narrow results. It tells a support bot which plan or platform a passage applies to, which prevents a whole class of wrong answers. And it gives you reports: how many pages exist for the enterprise plan, which product areas have no troubleshooting content.

Keep the metadata schema small and required. Five fields that are always filled in beat twenty that are filled in when someone remembers.

Plan for the growth events​

Most IA damage happens at a few predictable moments. It helps to decide in advance how each will be handled:

  • A new product or module. Does it get its own top-level section, or does it live inside an existing one? Decide by asking whether customers buy and use it separately.
  • A new plan tier. Handle plans with metadata and applicability notes on pages, not with separate sections per plan, which duplicate content immediately.
  • A deprecation. Decide where retired content goes, how long it stays and where its URLs redirect.
  • An acquisition or merger. Expect two vocabularies. Settle the vocabulary before merging navigation.

Governance: who can change the top level​

IA decays when anyone can add a top-level section. The governance we recommend is light: section owners can add pages and subsections freely within their area, but changes to the top level, and changes to the controlled vocabulary, need a named owner's approval. Record the decision and the reason in the repository.

Review the IA once or twice a year against real data: search queries with no results, the top support ticket drivers and the pages readers reach through search but never through navigation. Tree testing, where you ask people to find things using only the navigation labels, is a cheap way to check a proposed structure before building it.

If your documentation has outgrown its structure, a migration or a restructuring project is the moment to fix it properly. Our documentation migration service includes a target information architecture designed from your content inventory, not from the old sidebar. Send us a link to your current docs through the contact page. We reply within 1 business day.