Google Season of Docs Final Project Report

📝 Original project proposal
💓 Blog post on the GraphQL Foundation site about my project
🔗 Resulting page on graphql.org
📋 List of successful 2020 technical writing projects

Create FAQ resource

That was the title of my project and that was exactly what I did throughout my time participating in Google Season of Docs (GSoD).

🔗 Current version of the deployed FAQ resource: https://graphql.org/faq/

These were the top 25 questions out of over 150 potential questions that I scraped from various resources. These resources included online sites like StackOverflow and Reddit, issues filed in the GraphQL organization repositories, as well as speaking with prominent teachers in the GraphQL community.

Once the initial version of the page was launched, I gathered feedback from all types of GraphQL learners to see if the page was clear, useful, and what could be added to improve it in the future. In total, I've spoken with over 30 people.

Project goals

There were two main goals behind this FAQ page:

1. Build a centralized resource for everyone - The FAQ content will be framework agnostic and vendor-neutral.
2. Become a truly community-owned resource - This should be a resource that everyone is welcome to contribute to and the community feels empowered to change and grow.

✅ Goal 1 was accomplished by extensive research, working closely with my mentor, rigorous review of the content by the GraphQL TSC, and gathering community feedback.

✅ Goal 2 is ever-evolving, but steps were taken to ensure that people know how to contribute and share their ideas. This was done by adding and updating internal documentation:

• Created a new contributing guide
• Revamped the README
• Added new issue and pull request templates 

What's next

Because this is a community resource, the hope is that people from the GraphQL community will contribute to this page as they see fit. There are also issues tagged with the FAQ label for those who want to get involved but need some inspiration.