Cette page contient les détails d'un projet de rédaction technique accepté pour la 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 (trois mois)
Project description
Apprendre une nouvelle technologie n'est jamais facile, et cela pose de nombreuses questions. Avec GraphQL, le projet a suffisamment évolué pour que, dans la plupart des cas, les informations soient disponibles. Il suffit de les trouver, car ces informations sont dispersées dans diverses ressources et communautés de programmation.
Une section centrale de questions fréquentes pourrait être un élément d'amélioration important pour les utilisateurs de GraphQL. Ce n'est actuellement pas le cas sur graphql.org, ce qui entraîne des questions qui sont constamment répétées ou laissées sans réponse.
Cette nouvelle section de questions fréquentes sera intégrée au site Web graphql.org. Elle contiendra des rubriques sur les sujets suivants:
Historique et interne 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 avancés de GraphQL
- Comment effectuer la 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 ?
- Quelle est la meilleure façon de suivre les notes de version ?
D'autres sections seront probablement disponibles prochainement. Les questions ci-dessus sont des exemples potentiels. Ce sont aussi des questions que des collègues qui apprennent ou qui m'ont contacté après une conférence sur GraphQL m'ont posées.
Les questions de la FAQ seront collectées dans différentes zones d'Internet, puis triées et hiérarchisées. Voici quelques exemples:
- Stack Overflow
- Problèmes GitHub (dans l'organisation GraphQL, How To GraphQL et plus encore)
- Conversations avec de célèbres instructeurs GraphQL
- Pages produit liées à GraphQL
- Quora
En plus d'un contenu succinct et utile, la page de questions fréquentes finale sera conçue en tenant compte de l'expérience utilisateur et de l'accessibilité.