דרישות לגבי תוספים

גרסה 1.0, 30 באפריל 2024.

הקריטריונים שמופיעים בדף הזה חלים על כל התוספים ל-Classroom. כדי שהתוסף יאושר לפרסום ב-Google Workspace Marketplace, הוא חייב לעמוד בכל הפריטים הרלוונטיים, ובתוסף מסוג 'עובד עם Classroom'.

את מילות המפתח "חובה", "חובה", "נדרש", "SHALL", "צריכה לא", "צריכה", "מומלץ", "MAY" ו"אופציונלי" במסמך זה, יש לפרש כפי שמתואר ב-RFC 2119.

דרישות

ID סוג
1.0 רישיון למשתמש קצה (אם רלוונטי)
  1.1 חובה להציג למשתמש הודעה ידידותית למשתמש אם אין לו רישיון. צריך לציין בהודעה בבירור את הסיבה שאי אפשר להשתמש בתוסף, ולהציע דרך פעולה שהמשתמשים יכולים לפתור. חובה
  1.3 בדף האפליקציה ב-Google Workspace Marketplace של התוסף חובה לציין פרטים לגבי דרישות הרישוי שייתכן שיידרשו כדי להשתמש בתוסף. אם לתוסף יש רמה בתשלום, בדף האפליקציה ב-Marketplace חייבים להופיע קישור לדף אינטרנט עם מידע נוסף על התמחור או יצירת קשר עם איש מכירות. חובה
2.0 כניסה של משתמשי קצה
  ‫2.1 משתמשים של מורים חייבים להיכנס לתוסף באמצעות כניסה יחידה (SSO) של Google.
אם התלמידים מתבקשים להיכנס לתוסף, הם חייבים להיכנס באמצעות כניסה יחידה (SSO) של Google.
חובה
  2.2 התוסף חייב להשתמש בכניסה יחידה של Google כדי להכניס משתמש באופן אוטומטי בביקורים הבאים בלי להציג בקשה להתחברות.
כשההינט להתחברות לא יוצר התאמה למשתמש שמחובר כרגע, התוסף חייב להציג למשתמש לחצן כניסה ולהעביר את ה-Login_hint לספריית ההרשאה כדי לסנן חשבונות לא חוקיים.
חובה
  2.7 כשמשתמש ב-Classroom עדיין לא מחובר לתוסף (כפי שנקבע על ידי עיון ברמז להתחברות), התוסף חייב להציג לחצן 'כניסה באמצעות חשבון Google' כדי לבצע פעולה מפורשת מצד המשתמש שיפעיל את תהליך הכניסה.
הערה: הפעולה הזו נדרשת כדי לעמוד בהנחיות המיתוג של Google, ועוזרת להימנע מחסימת חלונות קופצים.
חובה
  2.8 התוסף אמור להציג את זהות המשתמש שמחובר כרגע. מומלצת
3.0 כללי
  3.1 התוסף חייב לעמוד בהנחיות הכלליות לקבלת אישור מ-Google Workspace Marketplace. חובה
  3.2 אם משימה מופעלת בכרטיסייה חדשה או בחלון חדש באחד מהתהליכים ב-iframe, צריך להציג בה הודעה ידידותית למשתמש כדי לחזור ל-Classroom. חובה
  3.3 המשתמש חייב להשלים את התהליך רק באמצעות תהליך עבודה של תוסף, ולא לעבור לתהליך של ClassWork או להשתמש בלחצן השיתוף ב-Classroom. חובה
  3.4 בחירת התאמה לשוק המקומי: השפה אמורה להתבסס על ההעדפה המקומית המוגדרת על ידי הדפדפן, כאשר היא זמינה. מומלצת
  3.5 אם תוסף מגדיר את maxPoints, הוא חייב גם להגדיר את pointsEarned כשהתלמידים מסיימים להגיש באמצעות פרטי כניסה שמורים של המורה (מומלץ), או כשהמורה פותח את ההגשה ב-iframe של הסקירה של התלמידים. חובה
  3.9 התוספים אמורים להתאים להנחיות AA ב-WCAG 2.1 בנוגע לנגישות. מפתחי תוספים ידווחו בעצמם על כך שהם עומדים בדרישה הזו במועד השליחה, ושהתוסף ימשיך לעמוד בתאימות לשינויים עתידיים בתוסף. מומלצת
  3.10 כל שגיאה שמשתמש נתקל בה חייבת להיות קריאת לבני אדם. חובה
  3.11 אם studentViewUri, teacherViewUri או studentWorkViewUri מופעלים ממטלה שהועתקה או מקורס שהועתק, לתוסף אסור להציג דף שגיאה ב-iframe. חובה
  3.12 אם studentViewUri, teacherViewUri או studentWorkViewUri הופעלו ממטלה שהועתקה או מקורס שהועתק, התוסף צריך להציג קובץ מצורף חדש שהתלמיד צריך להשלים, ואסור להציג את התשובות של התלמיד/ה ממטלות או קורסים קודמים ב-iframe. מומלצת
4.0 גילוי קבצים מצורפים
  4.1 אם קובץ מצורף שדורש שליחה של הקובץ על ידי תלמידים, הקובץ המצורף חייב לכלול studentWorkReviewUri כדי שיטופל כסוג פעילות ולא כקובץ מצורף מסוג תוכן. חובה
  4.2 ה-iframe לזיהוי קבצים מצורפים חייב לספק ממשק משתמש שכולל לפחות אחת מהאפשרויות הבאות:
  • יצירת תוכן חדש לצירוף
  • עיון בספריית תוכן, בחירה וצירוף אליה
  • הוראות לצירוף תוכן מהאתר שלך או ממוצרים אחרים
חובה
  4.3 המורים צריכים להיות מסוגלים למצוא את כל התוכן/הפעילויות שזמינים למורה ולגשת אליהם. מומלצת
  4.4 חובה שהמורים יוכלו לצפות בתצוגה מקדימה של התוכן או הפעילות לפני שיתחייבו לצרף אותם למטלה. חובה
  4.5 אם המורה צריך/ה ליצור תוכן או פעילות לפני שאפשר לצרף אותם, יש להשלים את העבודה ב-iframe. מומלצת
5.0 תצוגה לתלמידים
  5.1 כשמתקינים את studentViewUri, אסור שהתוסף יוציא את המשתמש מה-iframe כדי לבצע פעולה מסוימת.
אם התוסף מוציא את המשתמש מה-iframe, חייבת להופיע הודעה או סימן אחר לכך שהתלמידים יכולים לחזור ל-Classroom.
מומלצת
  5.2 אם פעילות של תוסף קופצת מחוץ ל-iframe, חייבת להיות תצוגה מקדימה של המשימה ב-iframe. חובה
  5.3 אם תלמידים ותלמידות צריכים לבצע פעולה מסוימת כדי לסמן שהעבודה הסתיימה, אסור שהלחצן 'הגשה' יופיע בתווית 'הגשה' כדי למנוע בלבול עם הלחצן 'הגשה ב-Classroom'. חובה
6.0 תצוגה למורים
  6.1 למורה צריכה להיות אפשרות לראות מה התלמיד או התלמידה יראו כשהם יבצעו את המטלה. מומלצת
7.0 סקירה של עבודות התלמידים
  7.1 אם studentWorkReviewUri מופעל, התוסף חייב לעבד את העבודה של התלמיד/ה לבדיקה על ידי המורה בתוך ה-iframe. ייתכן שיהיו קישורים לחומרים נוספים מחוץ ל-iframe. חובה
  7.2 אסור שהתוסף יאפשר ניווט בין תלמידים בתצוגה המפורטת studentWorkReviewUri. הניווט בין התלמידים חייב להתבצע בממשק המשתמש של Classroom בלבד. חובה
8.0 תמיכה ב-Classroom לנייד
  8.1 כשאפליקציית Classroom לנייד משיקה teacherViewUri, studentViewUri או studentWorkReviewUri, כתובת ה-URL חייבת לפתוח את אפליקציית הנייטיב לנייד של השותף או את אפליקציית האינטרנט לנייד של השותף. בכל מקרה, כתובת ה-URL צריכה לבצע קישור עומק לתצוגה הנכונה. אם המכשיר לא נתמך, המשתמש צריך להציג הודעה כדי להודיע לו שהמכשיר לא נתמך, ורצוי להציג לו את המכשירים הנתמכים. חובה
  8.2 חובה להשלים עבודות של תלמידים במכשיר נייד. מומלצת
9.0 תכונות נוספות
  9.1 אם המורים יכולים להדביק את הקישורים לתוכן שלכם כקבצים מצורפים של קישורים, עליכם לשדרג קישורים לקבצים מצורפים של תוספים. מומלצת
  9.2 אם אתם משתמשים בשילוב של CourseWork כדי ליצור מטלות מחוץ ל-Classroom, כדאי ליצור קבצים מצורפים לתוסף כברירת מחדל עבור כל הקישורים שתואמים לתוסף שלכם. מומלצת

יומן שינויים

גירסה 1.0 עדכון אחרון: 30 באפריל 2024
1.1 שילבנו את 1.1 ו-1.2 בדרישה אחת.
‫2.1 שילוב 2.1 ו-2.5 בדרישה אחת.
2.2 שילוב 2.2, 2.3 ו-2.4 בדרישה אחת.
3.5 שילוב 3.5, 3.6 ו-3.7 בדרישה אחת.
3.10 נוספה דרישה שהתוסף אף פעם לא ייכנס למצב לא מובן או שלא ניתן לשחזר.
3.11, 3.12 שילוב גרסאות 5.5, 5.6, 6.3, 6.4, 7.5 ו-7.6 לשתי דרישות חדשות.
4.2 הורחב התיאור של חוויות הגילוי של קבצים מצורפים מקובלים.
4.3 ממוספר מחדש, בעבר 4.2. בנוסף, הסטטוס 'חובה' ל-'מומלץ'.
4.4 ממוספר מחדש, בעבר 4.3.
4.5 ממוספר מחדש, בעבר 4.4.
5.2 מספור מחדש, בעבר 5.3.
5.3 ממוספר מחדש, בעבר 5.2.
9.1 נוספה המלצה לשדרג את הקישורים שהודבקו בטווח הקבצים המצורפים.
9.2 נוספה דרישה ליצור קבצים מצורפים של תוספים כברירת מחדל כשיוצרים מטלות ב-CourseWork באופן פרוגרמטי.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 הנושא הוסר.
גרסה 0.3 עדכון אחרון: 22 בנובמבר 2022
2.3 תיקון להדרכה לגבי הרמז להתחברות.
2.4 הוטמע תרחיש שבו צריך להטמיע את hd.
3.2 ניסוח מחדש של "הוספת נתיב".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 הוספנו את תוכן הקורס והנחיות מומלצות עבור studentViewUri, teacherViewUri ו-studentWorkReviewUri.
גרסה 0.2 עדכון אחרון: 29 באוקטובר 2021
1.3 שינינו את הטקסט כך שיהיה ברור יותר מהכוונה.
3.1 הוספנו את ההודעה "התוסף חייב לעמוד בהנחיות הכלליות לקבלת אישור של GWM, שמופיעות באתר".
3.9 WCAG השתנה 'נדרש' ל'מומלץ'.
5.1 ההגדרה 'נדרשת' שונתה ל'מומלצת'.
5.3 נוספה ההודעה "אם התוספים נפתחים מחוץ ל-iframe, חייבת להיות תצוגה מקדימה לגבי המשימה ב-iframe".
5.4 נוספה ההודעה "אם התוסף מופיע מחוץ ל-iframe, התלמידים אמורים לחזור ל-Classroom".
8.1 נוספה ההודעה "אם המכשיר לא נתמך, צריך להציג למשתמש הודעה כדי להודיע לו שהמכשיר לא נתמך. באופן אידיאלי, אילו מכשירים נתמכים".
8.2 עבודות התלמידים בנייד השתנו מ'נדרשת' ל'מומלצת'.
גרסה 0.1 עודכן ב-22 בספטמבר 2021
  גרסה ראשונית.