Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- GraphQL
- Penulis teknis:
- carolstran
- Nama proyek:
- Membuat referensi FAQ
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Mempelajari teknologi baru tidak pernah mudah - dan akan menimbulkan banyak pertanyaan. Dengan GraphQL, project telah berkembang cukup sehingga, sebagian besar, informasinya sudah tersedia. Anda hanya perlu menemukannya karena informasi tersebut tersebar melalui berbagai sumber daya dan komunitas pemrograman.
Bagian Pertanyaan Umum (FAQ) pusat dapat menjadi peningkatan instrumental bagi pelajar GraphQL. Hal ini saat ini tidak ada di graphql.org dan menyebabkan pertanyaan yang terus diulang atau tidak terjawab.
Bagian FAQ baru ini akan diintegrasikan ke 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 Advanced GraphQL
- Bagaimana cara melakukan penyimpanan dalam cache 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?
Dan kemungkinan akan ada lebih banyak bagian yang akan hadir. Pertanyaan di atas adalah contoh potensial. Semua itu juga adalah pertanyaan yang diminta oleh rekan-rekan yang sedang belajar atau setelah memberikan pembicaraan konferensi yang terkait dengan GraphQL.
Pertanyaan untuk FAQ akan bersumber dari berbagai area Internet dan kemudian diurutkan dan diprioritaskan. Beberapa area ini mencakup:
- StackOverflow
- Masalah GitHub (di organisasi GraphQL, How To GraphQL, dan lainnya)
- 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.