Uma interface web intuitiva e amigável para criar testes do Doc Detective sem necessidade de conhecimento técnico ou programação!
## 🚀 O que é isso?
Esta interface web permite que qualquer pessoa crie testes de documentação de forma visual e intuitiva, mesmo sem conhecer JSON ou linha de comando. É como um "construtor de testes" drag-and-drop para sua documentação.
## ✨ Funcionalidades
### 🎯 Criação Visual de Testes
- Templates Prontos*: 4 templates pré-configurados (Links, API, Tutorial, E-commerce)
- Interface Drag & Drop*: Adicione, remova e configure passos visualmente
- Configuração Intuitiva*: Formulários simples para cada tipo de teste
- Preview em Tempo Real*: Veja o JSON sendo gerado automaticamente
### 📊 Tipos de Teste Suportados
- ✅ Verificação de Links* - Testa se URLs funcionam
- 🌐 Navegação Web* - Simula cliques e navegação
- 🔍 Busca de Elementos* - Verifica se textos/botões existem
- 🛠️ Testes de API* - Valida endpoints e respostas
- 📸 Screenshots* - Captura telas para comparação
- ⌨️ Digitação* - Simula entrada de dados
### 🔧 Funcionalidades Avançadas
- Importação em Massa*: Cole múltiplas URLs de uma vez
- Estatísticas em Tempo Real*: Veja quantos testes de cada tipo você tem
- Download Direto*: Baixe o arquivo
.spec.jsonpronto para usar - Copiar & Colar*: Copie o JSON gerado para usar externamente
- Simulação de Execução*: Preview dos resultados esperados
## 🎮 Como Usar
### 1. Acesso Rápido (5 minutos)
-
Abra o arquivo
index.htmlno seu navegador -
Clique em um dos Templates de Início Rápido
-
Modifique as URLs para sua documentação
-
Clique em "Baixar" para obter o arquivo de teste
-
Execute:
npx doc-detective --input seu-arquivo.spec.json
### 2. Criação Personalizada (15 minutos)
-
Digite um nome para seu teste
-
Clique em "Adicionar Passo"
-
Escolha o tipo de ação (Link, Navegação, API, etc.)
-
Configure os detalhes (URL, texto, seletor, etc.)
-
Repita para adicionar mais passos
-
Baixe o arquivo e execute no Doc Detective
### 3. Importação em Massa (2 minutos)
-
Cole todas suas URLs na área "Importação em Massa"
-
Clique em "Importar URLs"
-
Todos os links viram testes automaticamente
-
Baixe e execute
## 📱 Interface Responsiva
A interface funciona perfeitamente em:
- 💻 Desktop* - Experiência completa
- 📱 Mobile* - Interface otimizada para celular
- 🖱️ Tablet* - Touch-friendly
## 🎨 Recursos Visuais
### Templates Incluídos:
- 🔗 Teste de Links* - Valida URLs básicas
- 📊 API Documentation* - Endpoints e health checks
- 📖 Tutorial/Guia* - Navegação step-by-step
- 🛒 E-commerce* - Fluxos de compra e busca
### Indicadores Visuais:
- 🔵 Badges coloridos* para cada tipo de teste
- 📊 Estatísticas em tempo real*
- ✅ Feedback visual* para ações realizadas
- 🎯 Preview JSON* atualizado automaticamente
## 🛠️ Instalação Local
*# Clone ou baixe os arquivos*
*# Não precisa instalar nada - apenas abra no navegador!*
*# Estrutura dos arquivos:*
web-interface/
├── index.html *# Interface principal*
├── style.css *# Estilos visuais*
├── script.js *# Lógica da aplicação*
└── README.md *# Este arquivo*
## 🌟 Casos de Uso Perfeitos
### 📝 Para Criadores de Conteúdo
- Blogueiros verificando links
- Documentação técnica
- Sites corporativos
- Bases de conhecimento
### 👩💻 Para Desenvolvedores
- APIs e endpoints
- Tutoriais de código
- Documentação de projetos
- Changelog e releases
### 🏢 Para Equipes
- Validação de processos
- Treinamentos online
- Portais internos
- Sites institucionais
## 🎯 Vantagens da Interface Web
### ❌ Antes (Método Manual)
{
"tests": [
{
"steps": [
{
"checkLink": {
"url": "https://..."
}
}
]
}
]
}
- Requer conhecimento de JSON e sintaxe*
### ✅ Agora (Interface Visual)
-
Clique em "Template de Links"
-
Digite sua URL
-
Clique em "Baixar"
-
Pronto! 🎉
## 🚀 Próximos Passos
Depois de criar seus testes na interface:
- Execute localmente:
npx doc-detective --input meu-teste.spec.json
- Automatize no CI/CD:
- run: npx doc-detective --input tests/
- Monitore regularmente:
# Configure um cron job ou GitHub Actions
## 💡 Dicas Profissionais
### ⚡ Início Rápido
- Use templates para começar rapidamente
- Importe URLs em massa para testes de link
- Teste localmente antes de automatizar
### 🎯 Melhores Práticas
- Combine diferentes tipos de teste
- Use nomes descritivos para passos
- Agrupe testes por funcionalidade
- Monitore resultados regularmente
### 🔧 Troubleshooting
- URLs devem começar com
http://ouhttps:// - Elementos devem ter texto visível ou seletores CSS válidos
- APIs devem estar acessíveis publicamente (ou com autenticação configurada)
## 🤝 Contribuindo
Quer melhorar a interface? Suas ideias são bem-vindas:
- 🐛 Reportar bugs*
- 💡 Sugerir funcionalidades*
- 🎨 Melhorar design*
- 📖 Atualizar documentação*
## 📄 Licença
Este projeto segue a mesma licença do Doc Detective principal.
## 🎉 Comece Agora!
-
Abra
index.htmlno navegador -
Escolha um template
-
Customize para sua documentação
-
Execute e veja a mágica acontecer!
- Doc Detective + Interface Web = Documentação sempre confiável! 🚀*