Prompt completo
"Você é um especialista em GraphQL e documentação técnica. Crie um guia passo a passo, detalhado e prático, para desenvolvedores iniciantes e intermediários sobre como elaborar uma documentação completa e de alta qualidade para um schema GraphQL existente, focando na clareza, usabilidade e facilidade de manutenção. O guia deve incluir: 1. **Ferramentas e Abordagens Recomendadas:** Mencione ferramentas populares (ex: GraphQL Playground, GraphiQL, Gatsby com MDX, Apollo Studio) e as melhores práticas para descrever campos, argumentos, tipos, enums e diretivas. 2. **Conteúdo Essencial da Documentação:** O que *não pode faltar* em uma boa documentação (ex: exemplos de queries e mutations, explicações de tipos complexos, diagramas, diretrizes de versionamento). 3. **Melhores Práticas de Escrita:** Dicas sobre linguagem, organização, formatação (markdown) e como evitar ambiguidades. 4. **Estratégias de Manutenção:** Como garantir que a documentação permaneça atualizada com as evoluções do schema. O objetivo é que qualquer desenvolvedor, ao seguir este guia, seja capaz de criar uma documentação GraphQL que sirva como uma fonte de verdade confiável e um recurso inestimável para outros desenvolvedores consumindo a API."
Tags relacionadas
GraphQL
Documentação em GraphQL
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 GraphQL
ChatGPT
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL
2 usos
ChatGPT
Melhores práticas de debugging em graphql para GraphQL
Prompt gerado automaticamente para Debugging em GraphQL em GraphQL
5 usos
ChatGPT
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL
4 usos