الزامات افزودنی

نسخه ۱.۱، ۵ دسامبر ۲۰۲۴.

معیارهای موجود در این صفحه برای همه افزونه‌های Classroom اعمال می‌شود. افزونه شما باید تمام موارد مورد نیاز مربوط را برای تأیید جهت فهرست شدن در بازار Google Workspace و افزونه‌ای که «با Classroom کار می‌کند» داشته باشد.

کلمات کلیدی «باید»، «نباید»، «الزامی»، «باید»، «نباید»، «توصیه می‌شود»، «ممکن است» و «اختیاری» در این سند باید مطابق آنچه در RFC 2119 توضیح داده شده است، تفسیر شوند.

الزامات

شناسه نوع
۱.۰ مجوز کاربر نهایی (در صورت وجود)
۱.۱ وقتی کاربر لایسنس ندارد، باید یک پیام کاربرپسند به او نشان داده شود. این پیام باید به وضوح دلیل عدم امکان استفاده از افزونه را بیان کند و راهکاری را برای رفع مشکل به کاربر پیشنهاد دهد. توصیه شده
۱.۳ فهرست افزونه در بازار Google Workspace باید جزئیات مربوط به مجوز و الزامات اشتراک مورد نیاز برای استفاده از افزونه را مشخص کند. اگر افزونه دارای نسخه پولی باشد، فهرست بازار باید پیوندی به صفحه وبی ارائه دهد که اطلاعات بیشتری در مورد قیمت‌گذاری یا نحوه تماس با فروشنده ارائه می‌دهد. توصیه شده
۲.۰ ورود کاربر نهایی
۲.۱ کاربران معلم باید با استفاده از حساب کاربری گوگل (Google SSO) وارد افزونه شوند.
اگر از کاربران دانش‌آموز خواسته شود که به افزونه وارد شوند، باید با استفاده از حساب کاربری گوگل (Google SSO) وارد شوند.
الزامی
۲.۲ این افزونه باید از Google SSO استفاده کند تا در بازدیدهای بعدی، کاربر را به‌طور خودکار و بدون نمایش اعلان ورود، وارد سیستم کند.
وقتی راهنمای ورود، با کاربر فعلی وارد شده مطابقت نداشته باشد، افزونه باید کاربر را با یک دکمه ورود به سیستم ترغیب کند و login_hint را به کتابخانه auth ارسال کند تا حساب‌های نامعتبر فیلتر شوند.
الزامی
۲.۷ وقتی کاربر Classroom هنوز وارد افزونه نشده است (همانطور که با نگاه کردن به راهنمای ورود مشخص می‌شود)، افزونه باید دکمه «ورود با گوگل» را برای اقدام صریح کاربر جهت شروع فرآیند ورود به سیستم ارائه دهد.
توجه : این کار برای رعایت دستورالعمل‌های برندسازی گوگل ضروری است و همچنین به جلوگیری از مسدودکننده‌های پاپ‌آپ کمک می‌کند.
الزامی
۲.۸ افزونه باید نشان دهد که کاربر فعلی وارد شده کیست. توصیه شده
۳.۰ عمومی
۳.۱ این افزونه باید از دستورالعمل‌های کلی تأیید بازار کار گوگل پیروی کند. الزامی
۳.۲ اگر یک وظیفه از هر یک از مسیرهای iframe در یک تب یا پنجره جدید اجرا شود، باید یک پیام کاربرپسند برای بازگشت به Classroom ارائه دهد. توصیه شده
۳.۳ کاربر فقط باید این مسیر را با استفاده از یک گردش کار افزونه‌ای تکمیل کند و نباید به یک گردش کار درسی تغییر وضعیت دهد یا از دکمه اشتراک‌گذاری کلاس درس استفاده کند. الزامی
۳.۴ انتخاب محلی‌سازی: زبان باید بر اساس ترجیحات محلی تنظیم‌شده توسط مرورگر در صورت وجود، انتخاب شود. توصیه شده
۳.۵ اگر افزونه‌ای maxPoints را تعریف کند، باید pointsEarned نیز زمانی که دانش‌آموز با استفاده از اعتبارنامه‌های ذخیره‌شده معلم (توصیه می‌شود) یک ارائه را تکمیل می‌کند یا زمانی که معلم ارائه را در iframe بررسی کار دانش‌آموز باز می‌کند، تعیین کند. الزامی
۳.۹ افزونه‌ها باید با دستورالعمل‌های سطح AA WCAG 2.1 در مورد دسترسی‌پذیری مطابقت داشته باشند. توسعه‌دهندگان افزونه، خود گزارش می‌دهند که این الزام در زمان ارسال برآورده شده است و افزونه همچنان با تغییرات آینده افزونه مطابقت خواهد داشت. توصیه شده
۳.۱۰ هرگونه خطایی که توسط کاربر رخ می‌دهد باید برای انسان قابل خواندن باشد. توصیه شده
۳.۱۱ اگر studentViewUri ، teacherViewUri یا studentWorkViewUri از یک تکلیف کپی‌شده یا دوره کپی‌شده اجرا شوند، افزونه نباید صفحه خطا را در iframe نمایش دهد. الزامی
۴.۰ کشف دلبستگی
۴.۱ اگر پیوستی نیاز به ارسال توسط دانشجو دارد، پیوست باید شامل studentWorkReviewUri باشد تا به عنوان یک پیوست از نوع فعالیت و نه از نوع محتوا در نظر گرفته شود. الزامی
۴.۲ آی‌فریم کشف پیوست باید رابط کاربری‌ای داشته باشد که حداقل یکی از موارد زیر را ارائه دهد:
  • ایجاد محتوای جدید برای پیوست کردن
  • مرور، انتخاب و پیوست از یک کتابخانه محتوا
  • دستورالعمل‌های پیوست کردن محتوا از وب‌سایت یا سایر محصولات شما
الزامی
۴.۳ معلم باید بتواند تمام محتوا/فعالیت‌های موجود را پیدا کند و به آنها دسترسی داشته باشد. توصیه شده
۴.۴ معلم باید بتواند قبل از تعهد به پیوست کردن محتوا/فعالیت به تکلیف، پیش‌نمایشی از آن را ببیند. توصیه شده
۴.۵ اگر معلم برای ایجاد محتوا/فعالیت قبل از اینکه بتواند پیوست شود، به انجام کاری نیاز دارد، آن کار باید در iframe انجام شود. توصیه شده
۵.۰ نمای دانشجویی
۵.۱ وقتی studentViewUri اجرا می‌شود، افزونه نباید کاربر را برای انجام یک کار از iframe خارج کند.
اگر افزونه کاربر را از iframe بیرون بکشد، باید پیام یا نشانه دیگری برای بازگشت دانش‌آموزان به Classroom وجود داشته باشد.
توصیه شده
۵.۲ اگر یک فعالیت افزونه از iframe بیرون بیاید، باید پیش‌نمایشی از آن وظیفه در iframe وجود داشته باشد. توصیه شده
۵.۳ در صورت وجود، دکمه یا پیوندی در فعالیتی با برچسب «ورود» باید باعث ایجاد یک درخواست API برای ارسال کار دانش‌آموز برای بررسی معلم شود. الزامی
۶.۰ دیدگاه معلم
۶.۱ معلم باید بتواند ببیند که دانش‌آموز هنگام انجام تکلیف چه چیزی را خواهد دید. توصیه شده
۷.۰ بررسی کار دانشجویی
۷.۱ اگر studentWorkReviewUri اجرا شود، افزونه باید کار آن دانش‌آموز را برای بررسی معلم در داخل iframe رندر کند. مطالب تکمیلی ممکن است به خارج از iframe لینک شوند. الزامی
۷.۲ این افزونه نباید امکان پیمایش بین دانش‌آموزان را در نمای studentWorkReviewUri فراهم کند. پیمایش بین دانش‌آموزان فقط باید در رابط کاربری Classroom انجام شود. الزامی
۸.۰ پشتیبانی از موبایل کلاس درس
۸.۱ وقتی برنامه موبایل Classroom یک teacherViewUri ، studentViewUri یا studentWorkReviewUri را اجرا می‌کند، URL باید یا برنامه موبایل اصلی شریک یا برنامه وب موبایل شریک را باز کند و در هر دو صورت به نمای صحیح deep-link کند. اگر دستگاه پشتیبانی نمی‌شود، باید پیامی به کاربر نمایش داده شود تا به او اطلاع دهد که دستگاه پشتیبانی نمی‌شود و در حالت ایده‌آل، چه دستگاه‌هایی پشتیبانی می‌شوند. الزامی
۸.۲ کار دانشجویی باید بتواند روی دستگاه تلفن همراه انجام شود. توصیه شده
۹.۰ ویژگی‌های اضافی
۹.۱ اگر معلمان می‌توانند لینک‌ها را به عنوان پیوست‌های پیوند به محتوای شما الصاق کنند، شما باید لینک‌ها را به پیوست‌های افزونه ارتقا دهید . توصیه شده
۹.۲ اگر از یکپارچه‌سازی CourseWork برای ایجاد تکالیف از خارج از Classroom استفاده می‌کنید، باید به‌طور پیش‌فرض برای همه لینک‌های سازگار با افزونه خود، پیوست‌های افزونه ایجاد کنید . توصیه شده

تغییرات

نسخه ۱.۱ به‌روزرسانی‌شده در ۵ دسامبر ۲۰۲۴
۱.۱، ۱.۳، ۳.۲، ۳.۱۰، ۴.۴، ۵.۲ از الزامی به توصیه شده تغییر یافت.
۳.۱۲ برداشته شد.
۵.۳ اصلاح‌شده. تغییر اخیر به توسعه‌دهندگان افزونه‌ها اجازه می‌دهد تا با استفاده از API، مطالب ارسالی دانش‌آموزان را با اطمینان تحویل دهند.
نسخه ۱.۰ به‌روزرسانی‌شده در ۳۰ آوریل ۲۰۲۴
۱.۱ ۱.۱ و ۱.۲ را در یک الزام واحد ترکیب کرد.
۲.۱ ۲.۱ و ۲.۵ را در یک الزام واحد ترکیب کرد.
۲.۲ ۲.۲، ۲.۳ و ۲.۴ را در یک الزام واحد ترکیب کرد.
۳.۵ ۳.۵، ۳.۶ و ۳.۷ را در یک الزام واحد ترکیب کرد.
۳.۱۰ الزامی اضافه شده مبنی بر اینکه افزونه هرگز وارد حالت غیرقابل فهم یا غیرقابل بازیابی نشود.
۳.۱۱، ۳.۱۲ استانداردهای ۵.۵، ۵.۶، ۶.۳، ۶.۴، ۷.۵ و ۷.۶ را در دو الزام جدید ترکیب کرد.
۴.۲ شرح تجربیات قابل قبول کشف دلبستگی گسترش یافت.
۴.۳ شماره‌گذاری مجدد شده، قبلاً ۴.۲. همچنین از الزامی به توصیه‌شده تغییر یافته است.
۴.۴ شماره‌گذاری مجدد شده، قبلاً ۴.۳.
۴.۵ شماره‌گذاری مجدد شده، قبلاً ۴.۴.
۵.۲ شماره‌گذاری مجدد شده، قبلاً ۵.۳.
۵.۳ شماره‌گذاری مجدد شده، قبلاً ۵.۲.
۹.۱ توصیه‌ای برای ارتقاء لینک‌های پیست‌شده به پیوست‌ها اضافه شد.
۹.۲ توصیه‌ای برای ایجاد پیوست‌های افزونه به صورت پیش‌فرض هنگام ایجاد تکالیف CourseWork به صورت برنامه‌نویسی‌شده اضافه شد.
۲.۶، ۳.۷، ۳.۸، ۶.۲، ۷.۳، ۷.۴ برداشته شد.
نسخه ۰.۳ به‌روزرسانی‌شده در ۲۲ نوامبر ۲۰۲۲
۲.۳ اصلاحیه راهنمای ورود به سیستم.
۲.۴ سناریویی را گنجاند که در آن پیاده‌سازی hd مورد نیاز است.
۳.۲ عبارت «مسیر را فراهم کن» تغییر یافته است.
۵.۵، ۵.۶، ۶.۳، ۶.۴، ۷.۵، ۷.۶ راهنمای مورد نیاز و توصیه شده برای studentViewUri ، teacherViewUri و studentWorkReviewUri به نسخه درس اضافه شد.
نسخه ۰.۲ به‌روزرسانی‌شده در ۲۹ اکتبر ۲۰۲۱
۱.۳ متن را اصلاح کردم تا منظور واضح‌تری داشته باشد.
۳.۱ اضافه شد: «این افزونه باید از دستورالعمل‌های کلی تأیید GWM که در وب‌سایت آنها موجود است، پیروی کند.»
۳.۹ WCAG از «الزامی» به «توصیه‌شده» تغییر کرد.
۵.۱ «الزامی» به «توصیه‌شده» تغییر کرد.
۵.۳ اضافه شد «اگر افزونه‌ها از iframe بیرون بیایند، باید پیش‌نمایشی از آن وظیفه در iframe وجود داشته باشد.»
۵.۴ اضافه شد «اگر افزونه از iframe بیرون بزند، باید پیامی برای بازگشت دانش‌آموزان به کلاس درس نمایش داده شود.»
۸.۱ اضافه شده است: «اگر دستگاه پشتیبانی نمی‌شود، باید پیامی به کاربر نمایش داده شود تا به او اطلاع داده شود که این دستگاه پشتیبانی نمی‌شود و در حالت ایده‌آل، چه دستگاه‌هایی پشتیبانی می‌شوند.»
۸.۲ کار دانشجویی سیار از «الزامی» به «توصیه‌شده» تغییر کرد.
نسخه ۰.۱ به‌روزرسانی‌شده در ۲۲ سپتامبر ۲۰۲۱
انتشار اولیه.