GraphQL project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- GraphQL
- Technical writer:
- carolstran
- Project name:
- Create FAQ resource
- Project length:
- Standard length (3 months)
Project description
Learning a new technology is never easy - and it comes with a lot of questions. With GraphQL, the project has evolved enough that, for the most part, the information is out there. It’s just a matter of finding it because that information is scattered through various resources and programming communities.
Something that could be an instrumental improvement for GraphQL learners would be a central Frequently Asked Questions (FAQ) section. This is currently missing from graphql.org and leads to questions that are either constantly repeated or left unanswered.
This new FAQ section will be integrated into the graphql.org website and contain sections related to:
And likely more sections to come. The above questions are potential examples. They’re also all ones that I have been asked by colleagues who are learning or after giving a conference talk related to GraphQL.
The questions for the FAQ will be sourced through various areas of the Internet and then later sorted and prioritized. Some of these areas include:
- StackOverflow
- GitHub issues (in the GraphQL organization, How To GraphQL and beyond)
- Twitter
- Conversations with prominent GraphQL instructors
- GraphQL-related product pages
- Quora
In addition to succinct and helpful content, the final FAQ page will be built with UX and accessibility in mind.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis Google Season of Docs project aims to create a comprehensive FAQ resource for GraphQL learners, centralizing answers to common questions currently scattered across various platforms.\u003c/p\u003e\n"],["\u003cp\u003eThe FAQ section will be integrated into the graphql.org website and will cover topics ranging from GraphQL basics and history to advanced concepts and specification details.\u003c/p\u003e\n"],["\u003cp\u003eQuestions for the FAQ will be sourced from diverse online communities and expert insights, ensuring relevance and practicality for users.\u003c/p\u003e\n"],["\u003cp\u003eThe project will prioritize user experience and accessibility in the design and development of the FAQ page.\u003c/p\u003e\n"]]],["The core project involves creating a centralized FAQ section for GraphQL on graphql.org. The FAQ will address common questions regarding GraphQL's history, basics, advanced concepts, and specification. Content will be sourced from platforms like StackOverflow, GitHub, Twitter, and conversations with experts. The aim is to help new learners find answers to questions that may otherwise go unanswered. This resource will be built to ensure good user experience and accessibility.\n"],null,["# GraphQL project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: GraphQL\n\nTechnical writer:\n: carolstran\n\nProject name:\n: Create FAQ resource\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\nLearning a new technology is never easy - and it comes with a lot of questions. With GraphQL, the project has evolved enough that, for the most part, the information is out there. It's just a matter of finding it because that information is scattered through various resources and programming communities.\n\nSomething that could be an instrumental improvement for GraphQL learners would be a central Frequently Asked Questions (FAQ) section. This is currently missing from graphql.org and leads to questions that are either constantly repeated or left unanswered.\n\nThis new FAQ section will be integrated into the graphql.org website and contain sections related to:\n\n- GraphQL history and internals\n\n - What is the GraphQL Foundation?\n - When and why was GraphQL created?\n - What are the best resources for getting started?\n- GraphQL basics\n\n - What is the difference between GraphQL and REST/SQL/etc?\n - What are the best use cases for GraphQL?\n - Is GraphQL only for React developers?\n- Advanced GraphQL concepts\n\n - How can you do server-side caching with GraphQL?\n - Does GraphQL support offline usage?\n - How can you test your GraphQL API?\n- Specification\n\n - How can I contribute to the specification?\n - What's the best way to follow the specification releases?\n\nAnd likely more sections to come. The above questions are potential examples. They're also all ones that I have been asked by colleagues who are learning or after giving a conference talk related to GraphQL.\n\nThe questions for the FAQ will be sourced through various areas of the Internet and then later sorted and prioritized. Some of these areas include:\n\n- StackOverflow\n- GitHub issues (in the GraphQL organization, How To GraphQL and beyond)\n- Twitter\n- Conversations with prominent GraphQL instructors\n- GraphQL-related product pages\n- Quora\n\nIn addition to succinct and helpful content, the final FAQ page will be built with UX and accessibility in mind."]]
