בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- GraphQL
- כותבים טכניים:
- carolstran
- שם הפרויקט:
- יצירת משאב של שאלות נפוצות
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
תמיד קשה ללמוד טכנולוגיה חדשה, ויש בה הרבה שאלות. בעזרת GraphQL, הפרויקט התפתח מספיק כך שרוב המידע זמין. צריך רק למצוא את המידע הזה, כי המידע הזה מפוזר במקורות שונים ובקהילות תכנות.
שיפור משמעותי שיכול לעזור לאנשים ללמוד GraphQL הוא קטע מרכזי של שאלות נפוצות (FAQ). היעד הזה חסר כרגע ב-Chartql.org, ולכן הוא גורם לשאלות שחוזרות על עצמן או שמופיעות ללא מענה.
הקטע החדש של השאלות הנפוצות ישולב באתר graphql.org ויכלול קטעים שקשורים לנושאים הבאים:
היסטוריה ורכיבים פנימיים של GraphQL
- מהי GraphQL Foundation?
- מתי נוצר GraphQL ומדוע?
- מהם מקורות המידע הכי טובים לתחילת העבודה?
יסודות של GraphQL
- מה ההבדל בין GraphQL לבין REST/SQL וכו'?
- מהם התרחישים לדוגמה שהכי מתאימים ל- GraphQL?
- האם GraphQL מיועד רק למפתחי React?
מושגים מתקדמים של GraphQL
- איך אפשר לשמור במטמון בצד השרת באמצעות GraphQL?
- האם GraphQL תומך בשימוש במצב אופליין?
- איך בודקים את ממשק ה-API של GraphQL?
מפרט
- איך אפשר לתרום למפרט?
- מה הדרך הכי טובה לעקוב אחרי הגרסאות של המפרט?
סביר להניח שיתווספו עוד קטעים. השאלות שלמעלה הן דוגמאות אפשריות. אלה גם כל אלה שהתבקשתי על ידי קולגות הלומדים או אחרי הרצאת כנס שקשורה ל- GraphQL.
השאלות לשאלות הנפוצות יאוחדו ממקורות שונים באינטרנט, ולאחר מכן יסודרו ויוקצו להן רמות תעדוף. בין האזורים האלה:
- StackOverflow
- בעיות ב-GitHub (בארגון GraphQL, ב-How To GraphQL ועוד)
- שיחות עם מדריכים מובילים בנושא GraphQL
- דפי מוצרים שקשורים ל-GraphQL
- Quora
בנוסף לתוכן תמציתי ומועיל, דף השאלות הנפוצות הסופי יתוכנן תוך התחשבות בחוויית המשתמש ובנגישות.