Prompt completo
Crie um guia detalhado e acionável, em português, para desenvolvedores e arquitetos de software sobre como estruturar e manter a documentação de performance de APIs e microsserviços. O guia deve abordar os seguintes pontos: 1. **Tipos de métricas:** Quais métricas de performance (latência, throughput, erros, utilização de recursos) devem ser obrigatoriamente documentadas para cada endpoint/serviço? Forneça exemplos de como estas métricas devem ser apresentadas (ex: percentis, médias, picos). 2. **Contexto operacional:** Que informações contextuais são cruciais para entender os dados de performance (ex: ambiente de execução, versão do código, carga de tráfego esperada, dependências externas)? Como garantir que essa informação esteja sempre atualizada junto aos dados de performance? 3. **Ferramentas e formatos:** Sugira ferramentas e formatos eficientes para armazenar e visualizar essa documentação (ex: dashboards interativos, wikis, repositórios de código com arquivos Markdown/YAML). Discuta os prós e contras de cada um para diferentes cenários. 4. **Processo de atualização:** Proponha um processo claro para a atualização contínua da documentação de performance, integrando-o ao ciclo de desenvolvimento (CI/CD). Como garantir que as mudanças na performance sejam refletidas na documentação de forma automatizada ou semi-automatizada? 5. **Casos de uso e público-alvo:** Para quais cenários (troubleshooting, planejamento de capacidade, otimização de custos, auditoria) e para quais públicos (desenvolvedores, SREs, gerentes de produto) essa documentação é mais valiosa? Como adaptar a apresentação para cada um? 6. **Exemplo prático:** Inclua um exemplo prático de uma seção de documentação de performance bem estruturada para um endpoint REST hipotético, ilustrando os pontos abordados.
Tags relacionadas
Performance de Backend
Documentação em Performance de Backend
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Performance de Backend
ChatGPT
Guia para troubleshooting em performance de backend em Performance de Backend
Prompt gerado automaticamente para Troubleshooting em Performance de Backend em Performance de Backend
3 usos
ChatGPT
Guia para testing em performance de backend em Performance de Backend
Prompt gerado automaticamente para Testing em Performance de Backend em Performance de Backend
3 usos
ChatGPT
Guia para padrões de design em performance de backend em Performance de Backend
Prompt gerado automaticamente para Padrões de design em Performance de Backend em Performance de Backend
3 usos