Skip to main content
Industry

Documentation at the speed of a weekly release

The SaaS documentation problem is not writing. It is that the product moved again on Thursday, and nobody can tell you which of your 600 articles that invalidated.

  • Versioned with releases
  • In-app help
  • Coverage reporting

What do SaaS teams use a knowledge base for?

Four things, usually in this order: a public help centre that deflects support tickets, product documentation versioned against releases, in-app help embedded where users get stuck, and a developer portal for the API. TheDocs runs all four from one workspace, with shared authors and separate audiences, and reports on which articles are failing readers.

  • Parallel documentation versions with a reader-facing selector.
  • Scheduled publishing so docs land with the deploy.
  • Embedded in-app search and chatbot with signed-in user context.
  • OpenAPI-driven developer portal in the same workspace.
  • Deflection and content-gap reporting against your own baseline.
  • Unlimited readers, so growth never raises the documentation bill.
Content

What SaaS teams document

Onboarding and activation

The first-run path. The single highest-leverage documentation a SaaS company owns, and usually the least maintained.

Help centre

Task-based articles for the top support drivers, public and indexed, so search engines route the question to you.

Release notes

Dated, categorised and subscribable, linking to the articles each change affects.

API and integrations

OpenAPI reference plus quickstarts and recipes, in the same search index as everything else.

Internal support runbooks

Escalation paths and known issues, in a restricted category of the same project as the public help centre.

Admin and security docs

The material a buyer's IT team asks for during procurement - SSO setup, permissions, data handling.

In detail

The two things that decide whether it works

Staying level with the product

Documentation debt in SaaS accrues silently: nothing breaks, articles just quietly stop being true.

  • Fork a documentation version when you branch the release.
  • Schedule publish so documentation goes live with the deploy, not two weeks later.
  • Coverage report lists every article carried forward unreviewed, ranked by traffic.
  • Open a documentation task automatically when a PR with a given label merges.
  • Review cycles shorter for release-sensitive categories than for policy content.

Proving it is worth the headcount

Documentation teams are cut when they cannot show what they contribute. These are the numbers that hold up.

  • Support contacts per active customer, before and after, with release spikes marked.
  • Failed-search volume trending down as gaps are closed.
  • Article helpfulness on the pages that carry the most traffic.
  • Which articles activating accounts read in their first week, versus churning ones.
  • Organic search traffic to documentation, which for many SaaS companies is a real acquisition channel.

The activation comparison is usually the one that gets attention outside the support team.

Frequently asked

Questions people ask before they start

Tie documentation versions to releases and schedule the publish with the deploy. The coverage report then shows which articles the new version inherited without anyone reviewing them, so the backlog is explicit rather than invisible.

Yes - an embedded search widget or chatbot that passes the signed-in user's context, so answers can use documentation that user is entitled to see and appear on the screen where the problem is.

Indirectly but measurably. Accounts that fail to activate a feature are usually accounts that could not work out how. Tracking which articles activating and churning accounts read is one of the more useful things a SaaS documentation team can do.

Yes, as separate projects with their own domains, navigation and versions, sharing snippets for genuinely common content such as account and billing procedures.

Find out how many of your articles the last release invalidated.

Start free for 14 days. No credit card, no setup fee, and your content is yours to export at any time.

Questions first? Email sales@thedocs.in or call +91 8585953085.