GraphQL 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：
GraphQL
技術撰稿人：
carolstran
專案名稱：
建立常見問題資源
專案長度：
標準長度 (3 個月)

Project description

學習新技術絕非易事，而且會產生許多問題。有了 GraphQL，專案已充分發展，因此大部分資訊都已公開。只要找到這些資訊即可，因為這些資訊散布在各種資源和程式設計社群中。

對於 GraphQL 學習者來說，常見問題 (FAQ) 區域是可以改善的實用功能。目前 graphql.org 中沒有這項資訊，導致許多問題不斷重複出現，或未獲得解答。

這個新的常見問題部分將整合至 graphql.org 網站，並包含以下相關部分：

  • GraphQL 記錄和內部

    • 什麼是 GraphQL 基金會？
    • GraphQL 的建立時間和原因為何？
    • 有哪些最佳資源可供參考？

  • GraphQL 基本概念

    • GraphQL 和 REST/SQL 等有何差異？
    • GraphQL 的最佳用途為何？
    • GraphQL 是否僅適用於 React 開發人員？

  • GraphQL 進階概念

    • 如何使用 GraphQL 進行伺服器端快取？
    • GraphQL 是否支援離線使用？
    • 如何測試 GraphQL API？

  • 規格

    • 如何對規格做出貢獻？
    • 遵循規格版本的最佳方式為何？

日後可能還會新增更多專區。上方問題是可能的示例。這些問題都是我學習 GraphQL 時，或在演講完 GraphQL 相關內容後，同事向我提出的問題。

我們會從網路的各個區域收集常見問題，之後再進行分類和優先處理。包括：

  • StackOverflow
  • GitHub 問題 (在 GraphQL 機構、How To GraphQL 和其他地方)
  • Twitter
  • 與知名 GraphQL 講師的對談
  • GraphQL 相關產品頁面
  • Quora

除了提供簡潔實用的內容，最終的常見問題頁面也會以使用者體驗和無障礙設計為考量。