Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- GraphQL
- Redator técnico:
- carolstran (link em inglês)
- Nome do projeto:
- Criar recurso de perguntas frequentes
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Aprender uma nova tecnologia nunca é fácil e traz muitas perguntas. Com o GraphQL, o projeto evoluiu o suficiente para que, na maioria das vezes, as informações estejam lá. É só uma questão de encontrar, porque essa informação está dispersa em vários recursos e comunidades de programação.
Algo que poderia ser uma melhoria fundamental para os alunos do GraphQL seria uma seção central de Perguntas frequentes. No momento, não está presente no Graphql.org e pode resultar em perguntas repetidas ou deixadas sem resposta.
A nova seção de perguntas frequentes será integrada ao site dochartql.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 o GraphQL e o REST/SQL/etc?
- Quais são os melhores casos de uso para o GraphQL?
- O GraphQL é apenas para desenvolvedores do React?
Conceitos avançados do GraphQL
- Como é possível fazer o armazenamento em cache do lado do servidor com GraphQL?
- O GraphQL oferece suporte para uso off-line?
- Como você pode testar a API GraphQL?
Especificação
- Como posso contribuir com a especificação?
- Qual é a melhor maneira de acompanhar as versões das especificações?
E provavelmente mais seções estão por vir. As perguntas acima são exemplos possíveis. Eles também são todos aqueles que me pediram por colegas que estão aprendendo ou depois de dar uma palestra em conferência relacionada ao GraphQL.
As perguntas para as Perguntas frequentes serão extraídas de várias áreas da Internet e, em seguida, classificadas e priorizadas. Algumas dessas áreas incluem:
- StackOverflow
- Problemas do GitHub (na organização GraphQL, How To GraphQL e mais)
- Conversas com instrutores proeminentes do GraphQL
- Páginas de produtos relacionadas ao GraphQL
- Quora
Além do conteúdo sucinto e útil, a página final de perguntas frequentes será criada pensando na experiência do usuário e na acessibilidade.