Dicas de documentação em graphql para GraphQL
Prompt gerado automaticamente para Documentação em GraphQL em GraphQL
"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
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de GraphQL
Continue explorando prompts nesta categoria.
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL
Melhores práticas de debugging em graphql para GraphQL
Prompt gerado automaticamente para Debugging em GraphQL em GraphQL
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL