🌐
ChatGPT intermediate

Prompt para documentação em graphql em GraphQL

Prompt gerado automaticamente para Documentação em GraphQL em GraphQL

2 usos GraphQL

Prompt completo

Você é um especialista em GraphQL e documentação técnica. Crie um guia passo a passo detalhado e prático, em português brasileiro, para equipes de desenvolvimento que precisam otimizar a documentação de schemas GraphQL complexos e em constante evolução. O guia deve abordar:

1.  **Ferramentas e Estratégias:** Quais as melhores ferramentas (open-source ou comerciais) e metodologias para gerar, manter e consumir documentação GraphQL? Inclua exemplos práticos de uso de `graphql-js`, `Apollo Server`, `GraphQL Playground`, `GraphiQL`, `OpenAPI/Swagger` (se aplicável para gateways), e ferramentas de automação de documentação (ex: `graphql-docs`, `spectaql`, `docusaurus` com plugins GraphQL).
2.  **Boas Práticas de Design de Schema para Documentação:** Como desenhar um schema GraphQL (nomes de campos, tipos, descrições, argumentos) de forma que ele seja auto-documentável e fácil de entender para consumidores de API (frontend, mobile, parceiros)? Dê exemplos de como usar diretivas `@deprecated`, `@skip`, `@include` para melhorar a clareza.
3.  **Geração e Manutenção Automatizada:** Como configurar pipelines de CI/CD para gerar e publicar automaticamente a documentação a partir do schema, garantindo que ela esteja sempre atualizada? Inclua exemplos de scripts (bash, Node.js) ou configurações de ferramentas.
4.  **Consumo e Experiência do Desenvolvedor (DX):** Como garantir que a documentação seja facilmente acessível e utilizável por diferentes perfis de desenvolvedores? Discuta a importância de tutoriais, exemplos de queries e mutations, e a integração com IDEs.
5.  **Desafios Comuns e Soluções:** Aborde problemas como schemas muito grandes, múltiplas versões de API, documentação de resolvers complexos e a integração com sistemas legados.

O guia deve ser claro, conciso, e incluir exemplos de código/configuração onde apropriado, focado em ajudar equipes a escalar a manutenção de sua documentação GraphQL de forma eficiente e sustentável.

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