GraphQL 项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

开源组织：

GraphQL

技术文档工程师：

Carolstran

项目名称：

创建常见问题解答资源

项目时长：

标准时长（3 个月）

Project description

学习一项新技术绝非易事，在此过程中会遇到很多问题。在 GraphQL 的帮助下，该项目已经取得了很大的进步，因此在大多数情况下，相关信息都已经生成。关键在于找到这些信息，因为这些信息分散在不同的资源和编程社区中。

对于 GraphQL 学习者而言，可能对 GraphQL 学习者起到工具性改进的作用，那就是核心的常见问题解答 (FAQ) 部分。该机制目前在 chartql.org 中缺失，会导致问题不断重复或无答案。

这一新的“常见问题解答”部分将集成到 chartql.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 等）
• Twitter
• 与杰出 GraphQL 讲师进行对话
• 与 GraphQL 相关的产品页面
• Quora

除了简洁实用的内容之外，最终的“常见问题解答”页面在构建时还会考虑用户体验和无障碍功能。