Your Documentation Is Organized Like Your Org Chart, and Your Users Can't Find Anything

Clinton De Young Information Architecture

Open the navigation sidebar of most product documentation, and you can usually reconstruct the company's org chart. One section covers the Platform team's features, another covers the Integrations team, one covers Billing, and one covers whatever the Mobile group shipped last year. Each section is internally tidy. People who know their corner of the product well wrote each one.

And your users still can't find anything.

A customer who wants to "let our contractors log in with their own company accounts" doesn't know that the answer is split between Identity, Admin Console, and Billing. They search, open three pages that each cover part of the job, give up, and file a ticket or ping their account manager. Your support team answers the same cross-cutting questions every week, and your docs get a reputation for being thin, even though every individual page is accurate.

This is an information architecture problem, and it is one of the most common reasons good documentation fails.

Why docs end up shaped like the company

In 1968, Mel Conway observed that any organization that designs a system will produce a design whose structure is a copy of the organization's communication structure. Engineers know this as Conway's Law, usually in the context of software architecture. It applies to documentation with even more force.

Docs are written by the teams that own the features, reviewed by those teams, and filed where those teams can find them. Nobody decides to organize the docs by department. It simply happens, one reasonable decision at a time:

  • Ownership drives placement. A new page goes in the section owned by whoever wrote it, not where a reader would look for it.
  • Internal names leak out. Sections are labeled with project codenames or team vocabulary that customers never use.
  • Cross-team tasks have no home. Anything that touches three teams belongs to none of them, so it gets written three times, partially, or not at all.
  • The product menu becomes the table of contents. Mirroring the UI feels user-centered, but it only helps people who already know which screen holds the answer.

I spent decades as a software engineer before I became a technical writer, and I recognize this pattern from the inside. Engineers organize knowledge around the system's components because that is how they think about the system. Users organize their needs around the outcome they want, and they don't care which component delivers it.

Organize around tasks, not teams

The fix is not a prettier sidebar. It is a different organizing principle: structure the documentation around what readers are trying to accomplish, and let the ownership map live in your repository, not in your navigation.

A useful starting frame is Diátaxis, created by Daniele Procida, which separates documentation into four kinds that serve four distinct needs: tutorials, how-to guides, technical reference, and explanation. Reference material can follow the system's structure, because people consult it when they already know what they're looking for. Tutorials and how-to guides should follow the reader's goals, because that is how people arrive at them.

In practice, that means your top-level navigation answers questions like "How do I get set up?", "How do I connect this to the tools we already use?", and "How do I manage access for my team?" rather than listing product modules.

A task-first audit you can run yourself

You don't need a full redesign to find out how bad the problem is. Here is the process I use, and you can run it with your own team in a couple of weeks:

  1. List your readers' top tasks. Pull them from search queries on your docs site, sales and onboarding call notes, and the questions your customer-facing staff answer from memory. Phrase each one in the customer's words, not yours. Aim for twenty to forty.
  2. Trace each task through the docs. For every task, record how many pages a reader must open to complete it, and how many different top-level sections those pages live in. Anything that requires three or more sections is a strong signal of org-chart structure.
  3. Flag the vocabulary gaps. Note every place where the customer's phrase doesn't appear in a navigation label or page title. If users search for "SSO" and your section is called "Federation Services," that's a finding.
  4. Test the tree before you rebuild it. Draft a task-based navigation hierarchy, then run a tree test: ask a handful of real users where they would look for specific items, using only the navigation labels, with no content or visual design. Nielsen Norman Group describes this as an evaluation of a hierarchical category structure, and it's cheap enough to run on a whiteboard draft.
  5. Write the missing cross-team pages first. The tasks that span several teams are usually the ones generating the most frustration. Give each one a single, end-to-end guide with a clear owner, and link out to the reference pages each team maintains.

Two rules keep the new structure from decaying back into the old one. First, every task-based guide needs a named owner, even when the underlying features belong to several teams. Second, add a navigation review to your docs process: before a new top-level section is created, someone has to say which reader task it serves.

What this does not fix

Restructuring won't rescue content that is wrong, outdated, or thin in the places readers need depth. If your hard topics get a paragraph while your easy ones get a chapter, that is a separate problem, which I wrote about in Why Most Technical Documentation Gets the Difficulty Curve Backwards. Information architecture determines whether readers can find the answer. The content still has to be worth finding.

Why this is hard to do from the inside

Reorganizing documentation around tasks means someone has to understand the whole product well enough to see how the pieces combine, and has to be free to cut across team boundaries without negotiating every move. Internal writers are often embedded in a single team for exactly the reasons that caused the problem. Engineers can explain their own components, but nobody's job is the seams between them.

That is where an outside technical writer who reads code can help. I can sit with each team, understand what their part of the system actually does, and then write the end-to-end guides that none of them own.

Where to start

If your support team keeps answering questions that your docs technically already cover, the content probably isn't the problem. The structure is. I'd be glad to look at your current documentation, walk through a few of your customers' top tasks with you, and help you decide whether a restructure is worth it. You can reach me through the contact page.