Skip to main content

automadocs / solutions / index.md

Pick the setup that fits your team size and workflow

Technical writing approaches tailored to your team size, workflow, and deployment model.

01

Setups

Four ways to start

  1. 01

    API Documentation

    Generate and maintain API reference pages automatically. REST, GraphQL, or custom protocols.
  2. 02

    Open Source Projects

    Free writing tools for open source maintainers. Generate READMEs, contributing guides, and API references.
  3. 03

    Startups

    Ship reference content as fast as you ship code. Free tier to get started, scales with your team.
  4. 04

    Teams & scale

    More seats, SSO on Team, shared references - same self-serve product. Self-host is on the roadmap, not a promise today.

02

Choosing

How to Choose the Right Setup

Start with one use case

Most teams start with one repository and a single use case, then expand as their workflow matures. If your team publishes public APIs, start with API Documentation. If you maintain OSS libraries, start with Open Source and focus on contributor onboarding.

Match the stage

Early-stage startups usually prioritize speed, so the Startup setup is focused on getting pages live with minimal overhead. Teams with multiple repos and shared ownership usually move to the Team setup for centralized controls and repeatable standards.

Same core workflow

No matter where you begin, the core workflow stays the same: connect your repository, generate references from source, and keep updates automated on every push.

03

Checklist

Evaluation Checklist

After a refactor

Ask each tool how docs stay current after a refactor. AutomaDocs answers via GitHub webhooks: push to main and docs regenerate within 5 minutes. If a competitor's answer is “re-run the export manually,” that's the maintenance cliff most teams fall off after month three.

Three questions

For API teams: do endpoint changes propagate into reference pages automatically? For open source teams: can a first-time contributor find setup instructions without asking in Discord? For startups: what's the time from “we shipped a breaking change” to “the docs reflect it”?

One mechanism

AutomaDocs answers all three with the same mechanism: webhook-triggered regeneration on every push, with health scores that flag what's gone stale so nothing silently drifts.

Start with one repository.

Connect your repository, generate references from source, and keep updates automated on every push.

Connect GitHub