Полиси по оформлению модулей
Начало
У каждого модуля внизу есть небольшая таблица, в котором находится вся его метаинформация. На основе нее формируются таблицы для курсов и полный список модулей. В этой таблице есть поля Maintainer, Start Date и End Date (если они отсутствуют, то их можно дописать в конец в указанном порядке).
Как только Вы начинаете работу над каким-либо модулем, Вы указываете свое имя в поле Maintainer и дату начала в поле Start Date.
По завершении работы над модулем (когда модуль готов) ментейнер указывает End Date.
На страницах со списками модулей также присутствует поле Should be done, в котором указана желаемая дата окончания работы над модулем (расчитывается как дата начала плюс количество дней на написание модуля).
- Материалы в первую очередь нужны самые простые: технической документации много, и люди, которым она нужна, сами в состоянии ее найти
Критерии готовности модуля
- Текст модуля:
- Имеется лекционный минимум
- Имеется ?Итоговый текст?:
- Материалы модуля:
- Готовность лекционных материалов не ниже 70%
- Материал, имеющий значимое различие с ПСПО, или требующий комментария, должен быть прокомментирован в итоговом тексте модуля или в паспорте самого материала
Оформление ?итогового текста?
- Итоговый текст ? это лекционный минимум, дополненный ссылками на материалы
- Материалы полностью покрывают тематику лекционного минимума
- Формальный критерий: каждому пункту лекционного минимума соответствует не менее одной ссылки на материал
Если несколько пунктов обеспечиваются одним и тем же материалом, на него надо ссылаться в каждом из пунктов
- Если используемый материал требует комментариев (например, на предмет легкой устарелости, несоответствия ПСПО или особенностей авторской позиции), их желательно оставлять в конце итогового текста
- В конце итогового текста находятся, если нужны, ссылки на материалы, не следующие прямо из контекста лекционного минимума, но рекомендуемые к просмотру (?SEE ALSO?)
Прогресс
Приблизительный процент готовности для различных этапов формирования модуля:
0%?40% |
Сбор материалов (накидывание в любом формате ссылок), закрывающих полностью лекционный минимум |
40%?70% |
Решение проблем с лицензией и втягивание материалов |
70%?90% |
Итоговый текст (включая комментарии и ?see also?) |
90%?100% |
Вычитка ГК |