Skip to main content

Documentation is a product, not a release checklist

· 6 min read
Documentation studio

In many SaaS companies, documentation is a checkbox on the release ticket: "Update docs". Someone ticks it the day before launch, or the day after, or never. The docs are treated as a deliverable that comes after the real work, rather than as part of the product customers use. The cost of that shows up everywhere except in the docs budget: in support queues, in sales engineering time, in onboarding calls and, more recently, in support bots that confidently repeat whatever the docs got wrong.

This post is about what changes when documentation is run as a product: with users, owners, a backlog, a quality bar and a place in the release process. None of it requires a large docs team. Most of it requires decisions that nobody has made yet.

What "docs as a checklist" looks like​

You can usually recognize the checklist model from a few symptoms:

  • Documentation work starts after the feature is code-complete, so it is always late and always rushed.
  • The person writing the docs learns about the feature from a demo, not from the spec.
  • Nobody can say who owns a given page, so nobody updates it when the product changes.
  • The help center's structure is whatever accumulated, because no one is responsible for the whole.
  • Success is measured as "docs were published", not "customers could do the thing".

In this model, documentation cannot be good for long, no matter how talented the writers are. Good writing on a broken process produces a few excellent pages surrounded by stale ones.

Where the cost actually lands​

Poor documentation rarely shows up as a line item. It shows up in other teams' numbers.

Support. Every question the docs could have answered becomes a ticket. Every ticket where the agent has to write the answer from scratch, because there is no article to link, takes longer. And when the docs are wrong, agents stop trusting them and answer from memory, which spreads inconsistency.

Onboarding and activation. New customers who cannot complete setup on their own either churn quietly or need an onboarding call. Both are expensive.

Sales engineering. Prospects evaluating the product read the docs. When the docs are incomplete, sales engineers fill the gap in calls and emails, over and over.

Engineering. Developers get interrupted to answer the same internal questions, and product decisions get forgotten because they were never written down.

Support bots. An AI assistant built on your help center is only as good as the content it retrieves. Stale, duplicated or contradictory pages become confident wrong answers at scale.

What treating docs as a product means​

Running documentation as a product is less about new tools than about applying the disciplines you already use for software.

Users and jobs​

Start with who reads the docs and what they are trying to do: admins setting up the product, end users doing daily tasks, developers integrating, support agents looking for a link to send. Each group has different jobs, and the docs should be organized around those jobs rather than around your internal feature list.

Ownership​

Every section needs a named owner who is responsible for its accuracy, and the documentation as a whole needs one person responsible for structure, standards and the contributor experience. The handbook page on ownership and governance covers how we set this up so it does not depend on goodwill.

A backlog with real inputs​

Documentation work should come from a backlog prioritized by evidence, not only from release tickets. The best inputs are support tickets, search queries that return nothing, pages with high exit rates and questions from sales calls. Ticket data is especially valuable, because every ticket is a customer telling you, in their own words, what the docs failed to explain. We describe the method we use in turning support tickets into a knowledge base.

A quality bar​

Define what "done" means for a page: correct, tested against the current product, following the template for its content type, reviewed by its owner, linked from where readers need it. Automated checks can enforce part of this, such as broken links, missing metadata and banned phrases. People enforce the rest.

A place in the release process​

This is the change with the biggest effect. Documentation goes into the definition of done for a feature, and the docs change ships in the same release as the code change. In a docs-as-code setup, that can literally mean the docs pull request is linked to the code pull request and reviewed by the same people. Release notes are part of the same flow; we wrote a separate piece on a release notes template with a review gate.

Feedback and measurement​

Measure whether readers succeed, not whether pages exist. Useful signals include search queries with no results, feedback on individual pages, the proportion of tickets resolved with a link to an existing article and the topics that keep generating tickets despite having articles. None of these are perfect, but together they tell you where the docs are failing.

Who owns this in a growing SaaS company​

In a company of a few dozen people, a single documentation owner, often a technical writer or a support lead with dedicated time, can run this model with help from product and engineering. The key is that the role has authority over structure and standards, a seat in release planning and time that is not constantly borrowed by other work.

As the company grows, content ownership spreads to product areas while the docs owner keeps responsibility for the platform, templates and quality bar. What does not work at any size is shared ownership with no individual accountable: when everyone owns the docs, nobody does.

Where to start​

You do not need to change everything at once. The order we usually suggest:

  1. Name an owner for the documentation as a whole, and owners for the five highest-traffic sections.
  2. Add documentation to the definition of done for new features.
  3. Pull the top support ticket drivers from the last quarter and check which have good articles.
  4. Put the docs in version control with a basic review flow, if they are not there already.

Each step is small. Together, they turn documentation from a task that happens to the product into part of how the product is built.

If you want help setting up that operating model, a documentation migration is often the moment to do it, and our release operations retainer keeps docs and release notes in step with each release, from $900/month. Tell us how documentation works on your team today through the contact page. We reply within 1 business day.