Здесь собираются markdown-шаблоны, которые ускоряют процесс проверки домашних заданий, дополняют общие теоретические материалы личным опытом наставника, и помогают сохранять единую структуру и качество проверок на протяжении курса.
В процессе обучения эти шаблонные комментарии дополняются ситуативными комментариями в code review и консультациями, на которых мы обсуждаем со студентами проделанную работу.
Данный курс является курсом повышения квалификации для фронтендеров. Комментарии в целом рассчитаны на технический уровень студентов, которые изначально могут пройти курс до конца. Формулировки адаптируются со временем под возникающие вопросы, но планка остается стабильно высокой. У более слабых студентов, которые попали на курс не имея навыков работы с HTML, CSS, JS, Git, и неспособных самостоятельно настроить свое рабочее окружение, могут возникать сложности с пониманием процессов и задач на уровне самого учебника. Данные шаблонные комментарии не решают эту проблему. В таких ситуациях требуется предварительное дообучение студента.
Базовые шаблоны первичной и повторной проверки должны использоваться как основные комментарии в ревью при проверках д/з. Стандартные контрастные эмодзи разного цвета и формы (из набора, представленного ниже) должны быть первыми символами во всех комментариях - по ним мы можем легко отличать ошибки, требующие исправления, важные сообщения, и менее важные данные друг от друга в длинных ревью, что очень полезно при повторных проверках или при необходимости посмотреть, что студент делал раньше и с каким успехом.
Некоторые чеклисты также включают в себя важные оповещения для студентов. Так, например, в последнем задании про CSS есть напоминание о том, что нужно проверить все, что связано с CSS, и обратиться за консультацией при необходимости, прежде, чем переходить к следующим темам. В чеклистах, где нужно сослаться на закрепленный совет, делается отметка [ + СОВЕТ ], чтобы не забыть про него.
Советы собираются отдельно от чеклистов, независимо по каждой теме (Общее, CSS, SVG, Canvas, WebGL), чтобы можно было легко видеть общую картину. Ситуативные советы - без нумерации. Закрепленные - по номерам заданий.
Советы дополняют ревью, но не являются основанием для отправки задания на доработку, если все работает так, как и должно. Это делается, чтобы не сильно демотивировать студентов постоянными остановками - ошибки, описываемые здесь, можно поправить позже, благо курс длинный и есть возможности для этого.
Закрепленные советы содержат в себе дополнительную информацию, которая выходит за рамки учебника, но тем не менее нужна в работе. Эти советы дают направления для дальнейшего развития. Темы для этих советов собираются из личного опыта разработки проектов, подобных учебному, и статистически частых вопросов, которые возникают в процессе.
Также здесь присутствуют шаблоны для часто повторяющихся личных сообщений.
Шаблоны поделены на файлы, начинающиеся с букв и цифр, которые позволяют быстро получать их содержимое из консоли. 1 = первичная проверка, 2 = повторная, с = checklist, a = advice, m = message, остальные числа = номера модулей и заданий.
Переносы строк могут ломаться при просмотре файлов в обычном интерфейсе GitHub, но должны нормально работать в комментариях при code review.
Все ок:
✅ - Задание принято.
Все не ок:
🔴 - Нужно обязательно исправить (грубые ошибки, явные несоответствия обязательным критериям).
❌ - Задание не принято.
Процесс прохождения курса:
🔷 - Важное сообщение.
⌚ - Нужно подождать (например ждем ответ куратора по какому-то вопросу).
Второстепенные:
✏️ - Начало проверки.
🔒 - Совет закреплен за конкретным заданием.
☝️ - Нужно принять к сведению, обращать внимание в перспективе (мелкие недочеты, советы и.т.д.).
💡 - Дополнительные мысли для саморазвития (за рамками учебных задач).
👍 - "Молодец".
Примеры PR с ревью, построенных на этих шаблонах можно найти в репозиториях студентов.
CC BY 4.0
Copyright (c) 2024 Иван Богачев