docs(labs): сокращены правила написания заданий
Зачем: оставить только необходимые ориентиры для автора учебного текста. Что: раздел сокращен до трех согласованных абзацев, ссылки на оба образца сохранены. Проверка: git diff --check прошел; проверен diff единственного измененного файла.
This commit is contained in:
1 parent
3bfe9ca4ee
commit
1b95ce456c
1 file changed
+8
-24
@@ -42,32 +42,16 @@
|
||||
|
||||
### Как писать задания
|
||||
|
||||
Задание обращается к учащемуся на «вы». Начните с «Чему учит»: назовите
|
||||
умение, которое он получит. Затем объясните, для чего нужен результат, и
|
||||
ведите читателя по действиям. Термины раскрывайте там, где без них нельзя
|
||||
понять следующий шаг. Историю разработки оставляйте в рабочих справочниках.
|
||||
Пишите для учащегося: объясняйте, чему он научится, зачем нужны действия
|
||||
и как понять результат. Историю разработки оставляйте за пределами задания.
|
||||
|
||||
Раздел «Как проверить себя» описывает способ проверки: что выполнить,
|
||||
с чем сравнить и где искать причину расхождения. Если проверка и есть ход
|
||||
исследования, сохраните ее в шагах, без повторного раздела. В конце задания
|
||||
«Что должно получиться» помогает учащемуся оценить результат: что у него
|
||||
работает, что он проверил и что может объяснить. Пишите о наблюдаемом
|
||||
результате: «числа на графике совпадают с запросом», «вы можете объяснить
|
||||
причину ошибки». Местоимение «вы» нужно там, где оно помогает обратиться
|
||||
к читателю. Подробный порядок действий остается в основной части.
|
||||
«Как проверить себя» описывает действия для проверки и поиска ошибок.
|
||||
«Что должно получиться» — результат работы и то, что учащийся теперь может
|
||||
объяснить. Если проверка уже встроена в шаги упражнения, повторять ее
|
||||
отдельным разделом не нужно.
|
||||
|
||||
Заголовки остальных разделов выбирайте по содержанию: «Для чего нужна
|
||||
витрина», «Найдите причину», «Как даг запускает ваши запросы». Число разделов
|
||||
и пунктов определяется упражнением. Ограничения объясняйте рядом с действием,
|
||||
которого они касаются; завершение опыта включает восстановление данных или
|
||||
удаление временных объектов, когда это требуется.
|
||||
|
||||
При вычитке сохраняйте состав результата, технические условия, способы
|
||||
проверки и самостоятельную часть работы. Новое упражнение или готовое решение
|
||||
под видом пояснения меняет учебный смысл и требует отдельного обсуждения.
|
||||
Формат инженерных issues из правил трекера относится к разработке стенда;
|
||||
учебные задания пишутся по этим правилам. Образцы:
|
||||
[дашборд Superset](../labs/optional/superset-dashboard.md) и
|
||||
Остальные заголовки и структуру выбирайте по содержанию. Образцы — задания
|
||||
про [дашборд Superset](../labs/optional/superset-dashboard.md) и
|
||||
[расследование подключения](../labs/optional/superset-missing-object.md).
|
||||
|
||||
## 3. Основная программа — семь ступеней
|
||||
|
||||
Reference in new issue
Block a user