Passo a passo com screenshots
Linguagem simples, passos numerados e a tela da sua aplicação anotada em cada etapa.
Documentação para usuários finais
Seu código vira uma central de ajuda que se atualiza sozinha.
O Docraft lê o código do seu repositório no GitHub e escreve, com IA, uma documentação passo a passo para quem usa o seu sistema, com screenshots anotados de cada tela. A cada merge na branch principal, só as páginas afetadas são atualizadas.
Gratuito durante o lançamento. Você só precisa de uma conta no GitHub.
Passo a passo visual
Cada passo mostra a tela certa, com destaque onde clicar
O Docraft não só descreve o caminho: cada passo vem com um screenshot da sua aplicação, anotado com números e destaques, para o usuário saber exatamente o que fazer.
- Passos numerados, na ordem em que o usuário faz
- Screenshots das telas da sua aplicação
- Anotações que apontam botões, campos e menus
- Imagens atualizadas junto com o texto a cada merge
Como funciona
Três passos e a documentação acompanha o seu código
-
1
Conecte o GitHub
Entre com o GitHub, instale o app do Docraft e escolha os repositórios que quer documentar.
-
2
Confira a configuração
Ative o repositório: o Docraft sugere o nome, o idioma e as cores a partir do código. Nada para acrescentar ao repositório.
-
3
Faça merge e pronto
A cada merge na branch principal, o Docraft lê o que mudou e atualiza os textos e os screenshots da sua documentação.
Recursos
Feito para quem usa o sistema, não para quem o programa
Só o que mudou
Cada merge atualiza apenas as páginas afetadas, sem reescrever tudo do zero.
Revisão quando quiser
Publique direto ou aprove cada atualização antes de ela ir ao ar.
Pública ou privada
Abra a documentação para todos ou convide leitores por e-mail.
Endereço próprio
Cada projeto ganha o seu subdomínio, hospedado e servido pelo Docraft.
Sem segredos no repositório
A Action se identifica com o OIDC do GitHub, e o código é lido pelo GitHub App.
Configuração
Configurada no próprio Docraft
Um formulário já preenchido a partir do código, sem arquivo para manter no repositório. As instruções para a IA ficam por conta do Docraft.
- Nome do projeto, idioma e quem pode ler
- Cores da sua marca na documentação e nos prints
- Perfis de usuário, com quem faz cada tarefa
- Ambiente de testes para os prints, com senhas criptografadas
Comece a documentar seus repositórios
Entre com o GitHub e veja o painel com seus repositórios e pull requests.