Prompt completo
Elabore um guia detalhado para engenheiros de backend sobre como criar e manter documentação técnica **eficaz e acionável** para métricas de performance de APIs e serviços. O guia deve abordar: 1. **Conteúdo essencial:** Que informações críticas (latência, throughput, erros, uso de recursos, etc.) devem ser documentadas para cada endpoint/serviço, e por que são importantes para a performance? 2. **Formato e ferramentas:** Exemplos de estruturas de documentação (e.g., Markdown, OpenAPI/Swagger com extensões, Confluence, etc.) que facilitem a compreensão e o uso rápido por equipes de desenvolvimento, SRE e operações. Inclua como integrar essa documentação com ferramentas de monitoramento. 3. **Processo de atualização:** Proponha um fluxo de trabalho (e.g., "document-as-code", gatilhos em CI/CD, responsabilidades claras) para garantir que a documentação de performance permaneça atualizada e reflita o estado real do sistema, evitando informações obsoletas que possam levar a diagnósticos incorretos ou otimizações ineficazes. 4. **Público-alvo:** Como adaptar a linguagem e o nível de detalhe para diferentes audiências (desenvolvedores, gerentes de produto, equipes de suporte) que precisam entender a performance do backend? 5. **Exemplos práticos:** Inclua pequenos exemplos de trechos de documentação bem elaborados para diferentes cenários (e.g., um endpoint CRUD, um serviço de processamento assíncrono).
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
2 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
2 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
2 usos