Skip to main content

Product Guide

Overview​

RepoDocs AI is a documentation system for SaaS API teams that use repositories to draft, review, and publish docs.

It's designed for teams that want more than a folder of templates. The repository combines documentation structure, AI-assisted drafting workflows, validation, examples, and publishing support in one installable system.

Audience​

  • SaaS engineering teams
  • API platform teams
  • Developer relations teams
  • Technical writers working in Git-based documentation workflows

What Problem It Solves​

RepoDocs AI helps teams solve four common documentation problems:

  • different services documented in different formats
  • slow manual documentation creation
  • low-trust AI-generated drafts without guardrails
  • documentation drift caused by weak validation and review workflows

What Makes It Different​

Normal documentation template packs usually stop at static files.

RepoDocs AI adds:

  • reusable templates across product, feature, API, governance, operations, and architecture docs
  • prompt packs for drafting and review
  • frontmatter, structure, and OpenAPI-aware validation
  • example systems and published-site views
  • export pipelines for teams that need broader publishing support

Start Here​

  1. Read docs/installation.md for setup.
  2. Review docs/ready-to-install-system.md for the full product walkthrough.
  3. Open docs/product-specification.md for the formal spec.
  4. Use templates/, prompts/, and examples/ to adapt the system into your own repository.