GraphQL プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:
GraphQL
テクニカル ライター:
carolstran
プロジェクト名:
よくある質問のリソースを作成する
プロジェクトの長さ:
標準の期間（3 か月）

プロジェクトの説明

新しい技術を学ぶことは決して簡単ではなく、多くの質問が寄せられます。GraphQL では、プロジェクトが十分に進化しているため、ほとんどの情報が公開されています。情報はさまざまなリソースやプログラミング コミュニティに散在しているため、見つけさえすれば問題ありません。

GraphQL の学習に役立つ改善点として、よくある質問（FAQ）セクションを中央に配置することをおすすめします。これは現在 graphql.org にはなく、常に繰り返される質問や、未回答のまま放置されている質問につながります。

この新しいよくある質問のセクションは、graphql.org ウェブサイトに統合され、以下の項目に関連するセクションが含まれます。

  • GraphQL の履歴と内部

    • GraphQL Foundation とは何ですか？
    • GraphQL はいつ、なぜ作成されたのですか？
    • 始めるにあたって、最適なリソースは何ですか？

  • GraphQL の基本

    • GraphQL と REST / SQL などとの違いは何ですか。
    • GraphQL のユースケース
    • GraphQL は React デベロッパー専用ですか？

  • GraphQL の高度なコンセプト

    • GraphQL でサーバーサイド キャッシュを行うにはどうすればよいですか？
    • GraphQL はオフラインでの使用をサポートしていますか？
    • GraphQL API をテストする方法

  • 仕様

    • 仕様に貢献するにはどうすればよいですか？
    • 仕様のリリースをフォローする最善の方法は何ですか？

今後さらにセクションを追加する予定です。上記の質問は、潜在的な例です。これらはすべて、GraphQL に関する学際やカンファレンスでの講演を終えた同僚から聞かれました。

よくある質問の質問は、インターネット上のさまざまな場所から集められ、後で選別され、優先順位が付けられます。これらの分野には次のものがあります。

  • StackOverflow
  • GitHub の問題（GraphQL 組織、How To GraphQL など）
  • Twitter
  • 著名な GraphQL インストラクターとの会話
  • GraphQL 関連のプロダクト ページ
  • Quora

最終的なよくある質問ページは、簡潔で有用なコンテンツに加えて、UX とアクセシビリティを念頭に置いて作成されます。