Projet GraphQL

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:
GraphQL
Rédacteur technique:
Carolstran
Nom du projet:
Créer une ressource de questions fréquentes
Durée du projet:
Durée standard (3 mois)

Project description

Apprendre une nouvelle technologie n'est jamais facile, et cela soulève de nombreuses questions. Avec GraphQL, le projet a suffisamment évolué pour que, dans l'ensemble, les informations soient accessibles. Il s'agit simplement de les trouver, car elles sont disséminées par le biais de diverses ressources et communautés de programmation.

Une section centrale des questions fréquentes (FAQ) pourrait constituer une amélioration instrumentale pour les participants à GraphQL. Ce point est actuellement absent de graphql.org et conduit à des questions qui sont constamment répétées ou laissées sans réponse.

Cette nouvelle section des questions fréquentes sera intégrée au site Web graphql.org et comportera des sections portant sur les sujets suivants:

  • Historique et éléments internes de GraphQL

    • Qu'est-ce que la GraphQL Foundation ?
    • Quand et pourquoi GraphQL a-t-il été créé ?
    • Quelles sont les meilleures ressources pour commencer ?

  • Principes de base de GraphQL

    • Quelle est la différence entre GraphQL et REST/SQL/etc ?
    • Quels sont les meilleurs cas d'utilisation de GraphQL ?
    • GraphQL est-il réservé aux développeurs React ?

  • Concepts GraphQL avancés

    • Comment effectuer une mise en cache côté serveur avec GraphQL ?
    • GraphQL est-il compatible avec l'utilisation hors connexion ?
    • Comment tester votre API GraphQL ?

  • Spécification

    • Comment puis-je contribuer à la spécification ?
    • Quel est le meilleur moyen de respecter les nouvelles spécifications ?

Il y en aura d'autres à venir. Les questions ci-dessus sont des exemples potentiels. C'est également le cas de collègues qui apprennent déjà ou à l'issue d'une conférence sur GraphQL.

Les questions de la FAQ seront tirées de différentes parties d'Internet, puis seront ensuite triées et classées par ordre de priorité. En voici quelques-uns:

  • StackOverflow
  • Problèmes GitHub (dans l'organisation GraphQL, How To GraphQL et au-delà)
  • Twitter
  • Conversations avec des enseignants GraphQL importants
  • Pages produits liées à GraphQL
  • Quora :

En plus du contenu succinct et utile, la page finale des questions fréquentes sera conçue dans un souci d'expérience utilisateur et d'accessibilité.