Project GraphQL

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:
GraphQL
Penulis teknis:
carolstran
Nama proyek:
Buat referensi FAQ
Durasi proyek:
Durasi standar (3 bulan)

Project description

Mempelajari teknologi baru tidak pernah mudah - dan hal ini menimbulkan banyak pertanyaan. Dengan GraphQL, proyek ini telah cukup berkembang sehingga, untuk sebagian besar, informasinya ada di luar sana. Anda hanya perlu menemukannya karena informasi tersebut tersebar melalui berbagai sumber daya dan komunitas pemrograman.

Sesuatu yang dapat menjadi peningkatan penting bagi peserta didik GraphQL akan menjadi bagian Pertanyaan Umum (FAQ) yang utama. Saat ini, kueri tersebut tidak ada di graphql.org dan menyebabkan pertanyaan yang terus-menerus diulang atau tidak terjawab.

Bagian FAQ yang baru ini akan diintegrasikan ke dalam situs graphql.org dan berisi bagian yang terkait dengan:

  • Histori dan internal GraphQL

    • Apa itu GraphQL Foundation?
    • Kapan dan mengapa GraphQL dibuat?
    • Apa saja referensi terbaik untuk memulai?
  • Dasar-dasar GraphQL

    • Apa perbedaan antara GraphQL dan REST/SQL/dll?
    • Apa kasus penggunaan terbaik untuk GraphQL?
    • Apakah GraphQL hanya untuk developer React?
  • Konsep GraphQL lanjutan

    • Bagaimana cara melakukan caching sisi server dengan GraphQL?
    • Apakah GraphQL mendukung penggunaan offline?
    • Bagaimana cara menguji GraphQL API?
  • Spesifikasi

    • Bagaimana cara berkontribusi pada spesifikasi?
    • Apa cara terbaik untuk mengikuti rilis spesifikasi yang telah dirilis?

Dan bagian lainnya akan segera menyusul. Pertanyaan-pertanyaan di atas adalah contoh potensial. Mereka juga dimintai oleh rekan-rekan yang sedang belajar atau setelah memberikan ceramah konferensi terkait GraphQL.

Pertanyaan-pertanyaan untuk FAQ akan bersumber dari berbagai area di Internet dan kemudian diurutkan dan diprioritaskan. Beberapa area tersebut mencakup:

  • StackOverflow
  • Masalah GitHub (di organisasi GraphQL, How To GraphQL, dan lainnya)
  • Twitter
  • Percakapan dengan instruktur GraphQL terkemuka
  • Halaman produk terkait GraphQL
  • Quora

Selain konten yang ringkas dan bermanfaat, halaman FAQ akhir akan dibuat dengan mempertimbangkan UX dan aksesibilitas.