GraphQL 项目

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

项目摘要

开源组织：
GraphQL
技术文档工程师：
Carolstran
项目名称：
创建常见问题解答资源
项目时长：
标准时长（3 个月）

Project description

学习新技术绝非易事，会涉及很多问题。随着 GraphQL 的不断发展，该项目已经足够成熟，大部分信息都已公开。只需找到这些信息即可，因为这些信息散布在各种资源和编程社区中。

一个集中的常见问题解答 (FAQ) 部分对 GraphQL 学习者来说非常有用。graphql.org 目前缺少这项内容，会导致问题不断重复或无人回答。

这个新的常见问题解答部分将集成到 graphql.org 网站中，并包含与以下内容相关的部分：

  • GraphQL 历史记录和内部机制

    • 什么是 GraphQL Foundation？
    • GraphQL 是什么时候创建的？创建原因是什么？
    • 哪些资源最适合新手入门？

  • GraphQL 基础知识

    • GraphQL 与 REST/SQL 等有何区别？
    • GraphQL 的最佳应用场景是什么？
    • GraphQL 是否仅适用于 React 开发者？

  • GraphQL 高级概念

    • 如何使用 GraphQL 进行服务器端缓存？
    • GraphQL 是否支持离线使用？
    • 如何测试 GraphQL API？

  • 规范

    • 如何为规范做出贡献？
    • 跟踪规范版本的最佳方式是什么？

我们还将推出更多内容区块，敬请期待。以上问题均为可能的示例。这些问题也是在学习 GraphQL 或在与 GraphQL 相关的会议上演讲后，同事们问我的。

我们会从互联网的各个区域寻找常见问题解答中的问题，然后再对其进行排序和优先排序。其中一些领域包括：

  • Stack Overflow
  • GitHub 问题（GraphQL 组织、How To GraphQL 及其他问题）
  • Twitter
  • 与知名 GraphQL 讲师的对话
  • GraphQL 相关产品页面
  • Quora

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