Prompt completo
"Você é um especialista em documentação técnica e revisão de código. Sua tarefa é analisar o trecho de um *pull request* que adiciona uma nova funcionalidade a um sistema legado e gerar sugestões de aprimoramento para a documentação técnica associada a essa alteração. Concentre-se em identificar lacunas, ambiguidades ou informações insuficientes que poderiam dificultar a compreensão futura por outros desenvolvedores. Para cada sugestão, explique brevemente o impacto potencial da falha na documentação e forneça um exemplo conciso de como a documentação poderia ser melhorada. **Contexto do Pull Request:** O *pull request* (PR) introduz um novo endpoint na API de um sistema de e-commerce. Este endpoint (`/api/v2/pedidos/{id}/status`) permite atualizar o status de um pedido para "enviado" ou "entregue" e, como efeito colateral, dispara um email de notificação para o cliente. A validação de status e permissões é feita por um novo *middleware* chamado `OrderStatusValidator`. O código inclui um novo serviço `EmailNotificationService` para o envio de emails. **Trecho de Documentação (Exemplo hipotético, a ser aprimorado por você):** ```markdown ### Feature: Atualização de Status de Pedido (v2) - Novo endpoint: `/api/v2/pedidos/{id}/status` - Permite atualizar o status do pedido. - Envia email ao cliente. - Utiliza `OrderStatusValidator`. --- ``` **Sua saída deve ser formatada da seguinte forma:** Para cada sugestão de aprimoramento da documentação: **Sugestão [Número da Sugestão]:** [Título curto e descritivo da sugestão] **Impacto Potencial da Falha:** [Descrição concisa do problema que a falta ou má documentação causaria] **Exemplo de Melhoria:** [Exemplo de como a documentação poderia ser reescrita ou complementada] **Exemplo de formato para uma sugestão (não precisa ser esta, apenas para ilustrar):** **Sugestão 1:** Detalhamento dos Status Válidos e Transições **Impacto Potencial da Falha:** Desenvolvedores futuros podem tentar atualizar para status inválidos, causando erros ou comport
Tags relacionadas
Code Review
Documentação em Code Review
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 Code Review
ChatGPT
Melhores práticas de casos de uso práticos em code review para Code Review
Prompt gerado automaticamente para Casos de uso práticos em Code Review em Code Review
2 usos
ChatGPT
Guia para troubleshooting em code review em Code Review
Prompt gerado automaticamente para Troubleshooting em Code Review em Code Review
1 usos
ChatGPT
Guia para melhores práticas em code review em Code Review
Prompt gerado automaticamente para Melhores práticas em Code Review em Code Review
1 usos