Prompt completo
"Você é um redator técnico sênior com vasta experiência em documentação de software e manuais de usuário. Seu público-alvo são desenvolvedores de software e engenheiros de QA, com diferentes níveis de proficiência técnica. **Problema:** A equipe de desenvolvimento acabou de lançar uma nova API RESTful para integração de pagamentos, mas a documentação existente é fragmentada, inconsistente e carece de exemplos práticos. Isso está gerando um alto volume de tickets de suporte e atrasando a integração por parte dos parceiros. **Tarefa:** Crie um prompt para um modelo de IA que possa auxiliar na geração de um guia de início rápido ("Quick Start Guide") para essa nova API. **O prompt deve incluir:** 1. **Contexto e público-alvo:** Deixar claro para quem é o guia e qual o objetivo principal. 2. **Estrutura básica do guia:** Sugerir seções essenciais (e.g., autenticação, endpoints principais, exemplos de uso). 3. **Formato dos exemplos:** Especificar a linguagem de programação preferencial para os exemplos de código (Python, Node.js e Java, sendo Python o prioritário) e o formato das requisições/respostas (JSON). 4. **Estilo e tom:** Sugerir um tom claro, conciso, direto e com foco na praticidade. 5. **Instruções de usabilidade:** Enfatizar a necessidade de clareza, uso de marcadores, listas numeradas e blocos de código bem formatados. 6. **Restrições/Considerações:** Alertar sobre a importância da segurança (e.g., não expor chaves de API em exemplos), a necessidade de place holders para credenciais e a inclusão de mensagens de erro comuns. **Seu prompt para o modelo de IA deve ser:** 'Gere um guia de início rápido (Quick Start Guide) para a nossa nova API RESTful de pagamentos, focando em desenvolvedores que precisam integrar rapidamente. O guia deve cobrir: 1. Como obter credenciais (placeholder); 2. Autenticação (OAuth 2.0 Client Credentials Flow); 3. Endpoints principais para criação de transação, consulta de status e reembolso; 4. Tratamento de erros comuns. Inclua exemplos de código em Python (
Tags relacionadas
Redator Técnico
Ferramentas para 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 troubleshooting em redator técnico em Redator Técnico
Prompt gerado automaticamente para Troubleshooting em Redator Técnico em Redator Técnico
2 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
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