本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- GraphQL
- 技术文档工程师：
- Carolstran
- 项目名称：
- 创建常见问题解答资源
- 项目时长：
- 标准时长（3 个月）
Project description
学习新技术绝非易事，过程中会遇到各种各样的问题。得益于 GraphQL，该项目已经取得了很大的进步，因此在大多数情况下，信息都存在。您只需要找到这些信息，因为这些信息分散在各种资源和编程社区中。
核心的常见问题解答 (FAQ) 部分可以为 GraphQL 学习者提供工具性改进。这一功能目前在 graphql.org 中缺失，会导致问题不断重复或未得到解答。
这一新的常见问题解答部分将集成到 graphql.org 网站中，其中包含与以下内容相关的部分：
GraphQL 历史记录和内部构件
- 什么是 GraphQL Foundation？
- GraphQL 是何时创建的，原因是什么？
- 入门的最佳资源有哪些？
GraphQL 基础知识
- GraphQL 和 REST/SQL/etc 有什么区别？
- GraphQL 的最佳使用场景有哪些？
- GraphQL 仅适用于 React 开发者吗？
高级 GraphQL 概念
- 如何使用 GraphQL 进行服务器端缓存？
- GraphQL 是否支持离线使用？
- 如何测试 GraphQL API？
规范
- 如何为规范做贡献？
- 遵循规范版本发布的最佳方式是什么？
未来可能还会推出更多版块上述问题可能仅供参考。这些也是我在学习中或在做过与 GraphQL 相关的会议演讲之后的同事问过我的所有内容。
我们会通过互联网的各个部分收集常见问题解答中的问题，然后对这些问题进行排序和优先级。其中一些领域包括：
- StackOverflow
- GitHub 问题（在 GraphQL 组织中、How To GraphQL 及更多内容）
- 与著名 GraphQL 讲师的对话
- 与 GraphQL 相关的产品页面
- Quora
除了简洁实用的内容之外，最终的“常见问题解答”页面在设计时充分考虑了用户体验和无障碍功能。