Projeto GraphQL

Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.

Resumo do projeto

Organização de código aberto:
GraphQL
Redator técnico:
carolstran
Nome do projeto:
Criar um recurso de perguntas frequentes
Duração do projeto:
Duração padrão (três meses)

Project description

Aprender uma nova tecnologia nunca é fácil e gera muitas dúvidas. Com o GraphQL, o projeto evoluiu o suficiente para que, na maior parte, as informações estejam disponíveis. É só uma questão de encontrar, porque essas informações estão espalhadas por vários recursos e comunidades de programação.

Uma melhoria importante para os alunos do GraphQL seria uma seção central de perguntas frequentes. No momento, isso não está disponível no graphql.org e leva a perguntas que são constantemente repetidas ou deixadas sem resposta.

Esta nova seção de perguntas frequentes será integrada ao site Graphql.org e conterá seções relacionadas a:

  • Histórico e aspectos internos do GraphQL

    • O que é a Fundação GraphQL?
    • Quando e por que o GraphQL foi criado?
    • Quais são os melhores recursos para começar?
  • Noções básicas do GraphQL

    • Qual é a diferença entre GraphQL e REST/SQL/etc?
    • Quais são os melhores casos de uso do GraphQL?
    • O GraphQL é apenas para desenvolvedores do React?
  • Conceitos avançados do GraphQL

    • Como fazer o armazenamento em cache do lado do servidor com o GraphQL?
    • O GraphQL oferece suporte a uso off-line?
    • Como você pode testar a API GraphQL?
  • Especificação

    • Como posso contribuir com a especificação?
    • Qual é a melhor maneira de seguir as versões de especificação?

E provavelmente mais seções estão por vir. As perguntas acima são exemplos possíveis. Também são perguntas que recebi de colegas que estão aprendendo ou depois de uma palestra sobre o GraphQL.

As perguntas das perguntas frequentes serão coletadas em várias áreas da Internet e depois classificadas e priorizadas. Algumas dessas áreas incluem:

  • StackOverflow
  • Problemas do GitHub (na organização do GraphQL, em Como usar o GraphQL e outros)
  • Twitter
  • Conversas com instrutores de destaque do GraphQL
  • Páginas de produtos relacionadas ao GraphQL
  • Quora

Além de conteúdo sucinto e útil, a página final de perguntas frequentes será criada pensando na UX e na acessibilidade.