Skip to main content
TheDocs
Sign in Book a Demo
Solution

Documentation that ships with the release

Not two weeks after it. Versioned articles, scheduled publishing, and a report of everything the new version quietly inherited without anyone checking.

Start free trial Book a demo
  • Parallel versions
  • Scheduled publish
  • Coverage report

What is product documentation?

Product documentation is the set of material that explains how to use a product: getting-started guides, task-based how-tos, conceptual explanation, reference material and release notes. It differs from a help centre in that it is versioned against the product, and from marketing content in that it is written for someone who has already bought and is trying to get something done.

  • Publish documentation for several product versions in parallel.
  • Schedule a publish so docs land with the deploy, not after it.
  • Coverage report lists articles carried forward unreviewed.
  • Release notes as a dated, categorised, subscribable stream.
  • Push Markdown from a repository, edit in the block editor.
  • Guides and API reference in the same portal and search index.
In detail

Keeping documentation honest across releases

Version the docs like you version the product

Documenting only the latest release is a decision to be wrong for every customer who has not upgraded.

  • Fork a documentation version when you branch the release; edit freely without touching what is live.
  • Publish versions in parallel with a reader-facing selector that persists across pages and search.
  • Mark old versions deprecated with a banner rather than deleting them and breaking links.
  • URLs carry the version, so a customer can bookmark documentation for the release they run.

Knowing what you did not check

The dangerous articles in a new release are not the ones you rewrote. They are the ones nobody opened.

  • Coverage view lists every article inherited unchanged from the previous version.
  • Sorted by traffic, so you triage the pages readers actually use.
  • Bulk-assign review with a due date straight from the list.
  • Optionally show readers when an article was last reviewed for their version.

This report is usually the first thing that surprises teams migrating in - the inherited-unchanged count is always higher than expected.

Release notes people actually read

A changelog dumped from commit messages is not a release note. It is a wall of text customers learn to skip.

  • Dated entries categorised as added, changed, fixed and deprecated.
  • Each entry links to the articles it affects, so 'what changed' leads to 'how it works now'.
  • Optional email subscription per product, so integrators hear about breaking changes.
  • Filter by version and by category, with an RSS feed for the people who prefer one.

Features that carry this use case

Versions & History

Every revision kept, compared side by side and restorable in one click.

Block & Markdown Editor

WYSIWYG blocks, Markdown and raw HTML in one editor, no mode switching.

API Documentation

OpenAPI-driven reference pages that stay in sync with your spec.

Multi-Language Docs

One article, many languages, with translation status tracked per version.

Review Workflows

Draft, review, approve, publish - with owners, due dates and reminders.

Developer & API Docs

Guides, tutorials and API reference in one developer portal.
Frequently asked

Questions people ask before they start

Fork a documentation version when you branch the release, edit it while the release is being built, and schedule the publish to coincide with the deploy. The coverage report tells you which articles were carried forward without being looked at.

Yes. Each product is its own project with its own domain or path, its own navigation and its own versions, while sharing snippets for the things that are genuinely common.

Yes, as a dated stream with categories - added, changed, fixed, deprecated - plus optional subscription so customers are emailed when notes are published. Notes link to the articles they affect.

In most teams that work, it is written by whoever built the thing and edited by someone who cares about consistency. TheDocs supports that split: engineers can push Markdown from a repo, and editors work in the block editor on the same articles.

Fork your docs when you branch your release.

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

Start free trial Book a 30-minute demo

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