Primeiros passos com Capydox | Documentação

1. Crie sua conta

Cadastre-se com e-mail e senha e confirme o e-mail quando receber o link. Se sua empresa usa uma organização com SSO, seu administrador pode conceder acesso sem senha local.

2. Crie ou abra um workspace

No painel de workspaces você pode criar um projeto pessoal ou entrar em um de equipe ou organização conforme seu papel. Cada workspace agrupa coleções, documentação, OpenAPI, evidências e configurações próprias.

3. Importe sua coleção

Em APIs → Importar envie coleções nos formatos compatíveis (Postman JSON, Insomnia YAML, ApiDog JSON). O Run2Doc gera a base técnica (endpoints, métodos, modelos) para documentar e vincular evidências.

4. Documente e revise

Documentação Markdown do workspace: visão geral do projeto.
Documento por coleção: edite Markdown por request ou na visão unificada.
Editor OpenAPI: mantenha um spec YAML/JSON por workspace com validação e prévia.

5. Evidências e ambientes

Execute ou registre testes e associe evidências a requests. Configure ambientes (URLs e variáveis) para alinhar a documentação com as implantações reais.

6. Cresça com a equipe

Com planos Team ou organização, convide membros, defina papéis e, no Business, configure SSO OIDC para seu domínio.

Checklist rápido

E-mail verificado.
Workspace principal definido pela equipe.
Convenções de nomes de coleções e versionamento acordadas.
Papéis e SSO revisados antes de convidar externos.