Pular para o conteúdo
Auth Support Docs
Entrar

DOCUMENTAÇÃO · APIs · DOCS-AS-CODE

Documentação técnica que sua equipe consegue escrever, revisar e publicar.

Editor visual, Markdown/MDX, OpenAPI, Git e importações no mesmo fluxo — com revisão, publicação, busca, analytics e um portal público rápido, sem prender o conteúdo à plataforma.

Entrar no StudioVer recursos

RECURSOS

Do rascunho à documentação publicada.

O mesmo conteúdo passa por edição, revisão e publicação sem ficar preso a um editor, a um formato ou à própria plataforma.

  • Escreva do seu jeito

    Use o editor visual ou trabalhe com Markdown/MDX. O conteúdo continua portátil e independente do editor.

  • Documente APIs de verdade

    Endpoints estruturados, parâmetros, exemplos, responses, OpenAPI 3.x, API Reference e Try It controlado.

  • Revise antes de publicar

    Draft, revisão, aprovação, histórico e snapshots publicados mantêm edição e produção claramente separadas.

  • Integre com Git

    Sincronize documentação com GitHub, visualize alterações e gere Pull Requests sem abandonar a experiência visual.

  • Traga o que já existe

    Importe documentação existente, Markdown e OpenAPI com preview, validação e preservação do conteúdo de origem.

  • Encontre e edite em equipe

    Busca rápida, analytics, feedback, edição colaborativa em tempo real e Ask Docs opcional sobre conteúdo publicado.

Capacidades

  • Markdown
  • MDX
  • OpenAPI
  • Importação
  • GitHub
  • API Reference
  • Try It
  • Search
  • Analytics
  • Realtime
  • Ask Docs

ARQUITETURA

Um modelo de conteúdo, vários fluxos.

Markdown, OpenAPI, importações e o editor visual convergem para um modelo canônico. A partir dele, a plataforma consegue editar, publicar, buscar, exportar e renderizar a documentação sem acoplar o conteúdo a uma única ferramenta.

Fontes

  • Markdown
  • MDX
  • OpenAPI
  • Importações
  • GitHub
  • Editor visual

Adapters / Parsers

NormalizedDocument

formato canônico, independente de editor

Consumidores

  • Editor visual
  • Public Docs
  • API Reference
  • Busca
  • Ask Docs
  • Export Markdown
  • Export OpenAPI
Nenhum consumidor lê o formato de origem diretamente. O que a plataforma não reconhece é preservado com o conteúdo original — nunca descartado.

SEM LOCK-IN

Seu conteúdo continua sendo seu.

A plataforma trata Markdown, MDX e OpenAPI como formatos de primeira classe e preserva conteúdo desconhecido em vez de descartá-lo silenciosamente.

  • Markdown, MDX e estrutura de pastas entram e saem da plataforma.
  • Conteúdo desconhecido é mantido com a fonte original.
  • Metadados de origem ficam guardados para auditoria e reimportação.

cobrancas.mdx

## Expiração

Cobranças expiram após 24 horas.

<Fluxo tipo="pix" />

Na plataforma

Expiração

Cobranças expiram após 24 horas.

Componente preservado

<Fluxo tipo="pix" />

Um componente MDX desconhecido continua no documento com o código original e volta igual na exportação.

Pronto para organizar sua documentação?

Entre no Studio para criar seu primeiro workspace, projeto e versão de documentação.

Abrir Studio