Prompt para documentação em redator técnico em Redator Técnico

Prompt gerado automaticamente para Documentação em Redator Técnico em Redator Técnico

5.0
33 usos
ChatGPT
Usar no ChatGPT
"Você é um redator técnico especialista em documentação de software, com foco em clareza, precisão e usabilidade para públicos técnicos e não-técnicos. Sua tarefa é criar um modelo de documento de requisitos funcionais (DRF) para um novo módulo de 'Gerenciamento de Logs de Erro' em um sistema de CRM B2B existente.

O DRF deve ser abrangente, mas conciso, e facilmente compreensível por desenvolvedores, gerentes de produto e stakeholders de negócios. Inclua as seções essenciais de um DRF de alta qualidade, como:

1.  **Introdução:** Breve descrição do propósito do documento e do módulo.
2.  **Escopo:** Limites do módulo, o que ele **faz** e o que ele **não faz**.
3.  **Glossário:** Termos técnicos ou específicos do negócio.
4.  **Requisitos Funcionais:** Detalhe cada funcionalidade esperada do módulo, utilizando o formato "O sistema DEVE permitir que o [ator] [ação] [objeto] [condição/resultado]". Pense em funcionalidades como:
    *   Visualização de logs (filtros por data, tipo, módulo, usuário).
    *   Pesquisa em logs.
    *   Exportação de logs (formatos comuns).
    *   Configuração de retenção de logs.
    *   Notificações de erros críticos.
5.  **Requisitos Não-Funcionais:** Desempenho, segurança, usabilidade, escalabilidade, etc., relevantes para um gerenciamento de logs.
6.  **Casos de Uso (Opcional, mas recomendado):** Exemplos de interações do usuário com o módulo.
7.  **Restrições:** Limitações técnicas, regulatórias ou de integração.
8.  **Critérios de Aceitação:** Como cada requisito será validado.

Adote um tom profissional e objetivo. O documento deve servir como um guia claro para a equipe de desenvolvimento e um ponto de referência para validação com os stakeholders. Priorize a organização lógica e a facilidade de leitura."

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de Redator Técnico

Continue explorando prompts nesta categoria.

Guia para melhores práticas em redator técnico em Redator Técnico

Prompt gerado automaticamente para Melhores práticas em Redator Técnico em Redator Técnico

Guia para fundamentos de redator técnico em Redator Técnico

Prompt gerado automaticamente para Fundamentos de Redator Técnico em Redator Técnico

Guia para fundamentos de redator técnico em Redator Técnico

Prompt gerado automaticamente para Fundamentos de Redator Técnico em Redator Técnico