Prompt completo
"Você é um redator técnico sênior com vasta experiência na criação de documentação clara, concisa e precisa para produtos de software complexos. Sua tarefa é criar um guia abrangente e prático, focado nas 'melhores práticas', para um novo redator técnico júnior que acabou de ser contratado em uma empresa de tecnologia. O guia deve abordar os desafios comuns e as estratégias eficazes para garantir que a documentação técnica seja não apenas precisa, mas também útil, acessível e engajadora para o público-alvo (desenvolvedores, usuários finais, administradores de sistema). O guia deve incluir, mas não se limitar a: 1. **Entendimento do Público-Alvo:** Como pesquisar e adaptar a linguagem e o nível de detalhe para diferentes personas. 2. **Estrutura e Organização:** Melhores práticas para arquitetura da informação, uso de títulos, subtítulos, listas, tabelas e diagramas. 3. **Linguagem e Estilo:** Consistência terminológica, clareza, concisão, uso de voz ativa, evitar jargões desnecessários. 4. **Colaboração e Fluxo de Trabalho:** Como interagir efetivamente com engenheiros, gerentes de produto e testadores; processos de revisão e aprovação. 5. **Ferramentas e Tecnologias:** Breve menção a tipos de ferramentas comuns (DITA, Markdown, ferramentas de captura de tela, etc.) e a importância de adaptabilidade. 6. **Manutenção e Atualização:** Estratégias para manter a documentação atualizada em um ambiente de desenvolvimento ágil. 7. **Métricas de Sucesso:** Como avaliar a eficácia da documentação (feedback do usuário, redução de chamados de suporte, etc.). O tom deve ser instrutivo, encorajador e profissional. Use exemplos hipotéticos quando apropriado para ilustrar os pontos. O objetivo final é capacitar o redator júnior a produzir documentação de alta qualidade que agregue valor real aos usuários e à empresa."
Tags relacionadas
Redator Técnico
Melhores práticas em Redator Técnico
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 Redator Técnico
ChatGPT
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
5 usos
ChatGPT
Guia para debugging em redator técnico em Redator Técnico
Prompt gerado automaticamente para Debugging em Redator Técnico em Redator Técnico
4 usos
ChatGPT
Guia para fundamentos de redator técnico em Redator Técnico
Prompt gerado automaticamente para Fundamentos de Redator Técnico em Redator Técnico
4 usos