ТЗ на основе бизнес-правил: пример для школьной системы

Когда при знакомстве с проектом становится понятно, что «мы не знаем, где границы того, чего мы не знаем», мы пишем техническое задание без спецификации реализации — но с подробным описанием бизнес-правил. Ниже — пример такого ТЗ для школьной системы: полный набор правил, готовый к разработке на любом фреймворке, в том числе на Laravel.

Когда техническое задание строят на бизнес-правилах

Классическое ТЗ описывает реализацию: экраны, поля, кнопки, сценарии нажатий. Но есть проекты, где на старте невозможно честно описать реализацию — предметная область сложная, а заказчик и команда ещё не видят всех её границ. В таком случае мы описываем не интерфейс, а правила, по которым живёт предметная область.

Мы не знаем, где границы того, чего мы не знаем.Признак проекта, которому нужны бизнес-правила вместо спецификации реализации

Перспективы для бизнеса (business opportunity), ради которых школа заходит в такой проект:

• Составление и изменение расписания в электронном виде.
• Коммуникация всех заинтересованных участников на единой платформе.
• Оперативное и своевременное оповещение всех заинтересованных участников системы.
• Доступ ко всем материалам обучения в электронном виде.
• Автоматизация многих процессов обучения.

Элементы предметной области и правила учебного дня

Первый блок — функциональные правила и ограничения, которые касаются учебного процесса в целом.

• BR-1. В системе используются академические часы обучения.
• BR-2. Интерфейс системы разрабатывается на украинском языке. Контент, который вносят пользователи школы, также создаётся на украинском.
• BR-3. Любые уроки и дополнительные занятия могут проводиться только в рабочие дни, с понедельника по пятницу.
• BR-4. В субботу и воскресенье занятия в школе не проводятся.
• BR-5. Академический час обучения (продолжительность урока) может быть разным в зависимости от группировки классов по возрасту: 1 классы, «начальная школа» — 35 минут; 2–4 классы, «средняя школа» — 40 минут; 5–11 классы, «старшая школа» — 45 минут.
• BR-6. Для некоторых предметов и занятий может быть определена специальная продолжительность урока: физкультура в 5–11 классах — 45 минут; спортивный кружок из дополнительного пакета во второй половине дня — от 45 до 60 минут и больше; прогулка для 2–4 классов — не менее часа.
• BR-7. Продолжительность перемен между уроками задаётся отдельно для начальной, средней и старшей школы; во все дни недели перемены между уроками одинаковые. После выполнения обязательной программы перемены между занятиями из дополнительного пакета могут различаться в зависимости от распределения прогулки, работы столовой и других факторов.
• BR-8. Начало занятий во все дни недели для всех классов одинаковое.

Числа, которые правила фиксируют жёстко:

Предмет и учебный план

Учебный план — основа, из которой вырастает всё расписание на год. Именно здесь появляются самые неочевидные для разработчика ограничения.

• BR-CURRICULUM1. Основой для формирования расписания на год является учебный план (учебная программа). Учебная программа определяется для каждого класса и характеризуется недельной часовой нагрузкой по классу. Недельная нагрузка складывается из «обязательной программы» и «дополнительного пакета». Обязательную программу определяет Министерство образования.
• BR-CURRICULUM2. Обязательная программа может иметь несколько вариантов, например «базовая программа» или «программа Интеллект». В таком случае завуч указывает это в названии учебного плана — скажем, рабочий учебный план для 1–3 классов на основе научно-методического проекта «Интеллект». Предельная недельная часовая нагрузка определяется для класса в зависимости от года обучения.
• BR-CURRICULUM3. «Дополнительный пакет» — это предметы, включённые в план обучения дополнительно, которые школа предлагает сверх «обязательной программы обучения». Предметы из дополнительного пакета ставятся в расписании учебного дня после предметов обязательной программы.
• BR-CURRICULUM4. В «дополнительный пакет» также могут входить дополнительные часы по предметам обязательной программы. В этом случае разницы между обязательными и дополнительными часами в расписании не существует.
• BR-CURRICULUM5. При формировании недельной нагрузки могут использоваться разные шаблоны базовой программы обучения (например, программа «Интеллект») и разные шаблоны дополнительного пакета (например, «Дополнительный пакет № 1»). Иначе говоря, внутри одной группы классов могут применяться разные шаблоны программы обучения: 2-А класс учится по стандартной программе от Министерства образования, а 2-Б — по программе «Интеллект».
• BR-CURRICULUM6. Распределение недельной нагрузки для классов проводится по семестрам на учебный год. В течение семестра недельная нагрузка меняться не может.
• BR-CURRICULUM7. Количество часов по предмету в недельной нагрузке указывается целыми часами. Если количество часов не целое, оно может быть кратным только 0,5.
• BR-CURRICULUM8. В разные семестры расписание (распределение уроков) недельной нагрузки может быть разным.
• BR-CURRICULUM9. Распределение нецелого количества часов возможно в двух вариантах: разное количество часов по чётным и нечётным неделям или разное количество часов в разных семестрах.
• BR-CURRICULUM10. Для распределения недельной нагрузки используется справочник выходных и праздничных дней и периодов каникул. Первый семестр имеет обычную продолжительность 16 недель, второй — 19 недель. Информация о периодах каникул, выходных и праздничных днях устанавливается документом «Рабочий учебный план» и известна в начале учебного года.
• BR-CURRICULUM11. После распределения недельной нагрузки контроль количества учебных недель не проводится.
• BR-CURRICULUM12. После распределения недельной нагрузки вручную возможна корректировка составленного расписания — изменение дней, включённых в каникулы или в учебные дни.

Класс, группы и потоки

• BR-CLASS1. Класс определяется уровнем (1, 2, 3 … 11 и буквой, если есть параллели: А, Б, В … Я), учебной программой и составом учеников.
• BR-CLASS2. Преподаватель может быть куратором только в одном классе.
• BR-CLASS3. Для некоторых предметов применяется деление класса на группы. Признаками деления могут быть: не более 10 человек в группе по иностранному языку; деление по уровню знания иностранного языка — elementary, intermediate, advanced (уровней может быть разное количество, обычно применяется для предмета «второй иностранный язык»); мальчики и девочки занимаются в отдельных группах на трудовом обучении. На физкультуре (основной урок) деления на группы по гендерному признаку не происходит.
• BR-CLASS4. Для класса могут задаваться часы недоступности в конкретные дни недели. На это время расписание для класса не составляется.
• BR-CLASS5. Для некоторых предметов возможно объединение разных классов в «потоки»: иностранный язык уровня elementary для 5–11 классов проводится одним потоком; физкультура (дополнительный пакет) для мальчиков 2 классов проводится вместе.

Аудитории

• BR-9. Для аудитории может быть определён специальный предмет, который читается только в ней: физика, химия, информатика. В таком случае аудитория считается специализированной.
• BR-10. В специализированных аудиториях могут проводиться занятия только по назначенному предмету.
• BR-11. Для одного предмета может быть несколько специализированных аудиторий.
• BR-12. Предмет с несколькими специализированными аудиториями желательно распределять для каждого конкретного класса в одной аудитории.
• BR-13. Для аудиторий может быть назначено несколько предметов: украинский язык и литература.
• BR-14. Некоторые аудитории относятся к общему фонду — в них можно проводить любые занятия: библиотека, лекционный зал, универсальная студия.
• BR-15. Для класса может быть назначена классная аудитория — «закреплённая за классом».
• BR-16. Предметы без специализированной аудитории желательно ставить в классной аудитории.
• BR-17. Для 1 и 2–4 классов все предметы, кроме специализированных, читаются только в назначенной классной аудитории.
• BR-18. В классных аудиториях 1 и 2–4 классов могут проводиться занятия только назначенного класса. Проведение занятий других классов запрещено.
• BR-19. В классных аудиториях 5–11 классов могут проводиться занятия других классов.
• BR-20. Для аудитории задаётся максимальное количество мест. Класс или группа не может проводить занятие в аудитории с недостаточным количеством мест.
• BR-21. При проведении занятия «потока» количество учеников определяется суммой учеников в объединённых классах и группах.

Преподаватель и столовая

Преподаватель

• BR-22. Для преподавателя задаются предметы, которые он читает.
• BR-23. За преподавателем 1 и 2–4 классов может быть закреплён класс, в котором он читает все предметы, кроме специализированных.
• BR-24. Для преподавателя могут задаваться условия доступности: не может проводить занятия в определённые дни недели; может проводить занятия только в определённые часы определённых дней недели; не может проводить занятия в определённом семестре, если контракт заключён только на один семестр.

Столовая

• BR-25. В столовой устанавливается время начала и продолжительность посещения: завтрак, обед, полдник, ужин.
• BR-26. Определяется время, необходимое для пребывания класса в столовой. Для всех классов с 1 по 11 время пребывания одинаковое — это интервал посещения.
• BR-27. Определяется количество мест в столовой, которое не могут превысить ученики классов, находящиеся там одновременно.
• BR-28. Классы, которые одновременно находятся в столовой во время интервала посещения, составляют группу.
• BR-29. Расписание столовой формируется из групп классов и интервалов их посещения столовой. Результат — документ «Расписание столовой».

Правила составления расписания

Обязательные к выполнению условия — доступность преподавателей и количество мест в аудиториях (BR-30). Дальше идут правила деления, объединения и очерёдности.

• BR-31. При делении класса на подгруппы занятия проводятся в разных аудиториях разными преподавателями.
• BR-32. При делении класса на подгруппы возможно проведение в одно время занятий по разным предметам, например английский язык и информатика.
• BR-33. При объединении классов в потоки занятие проводится в одной аудитории одним преподавателем.

Очерёдность распределения предметов в расписании:

1. Сначала — совместители. В первую очередь распределяются предметы учителей-совместителей (BR-34).
2. Затем — самые нагруженные предметы. Дальше распределяются предметы с наибольшим количеством часов недельной нагрузки (BR-35).
3. Затем — потоки. Последними распределяются предметы, которые позволяют создавать потоки (BR-36).

Пожелания, которые система учитывает, если это возможно:

• BR-37. Если возможно, не ставить более 2 языковых предметов в один день.
• BR-38. Если возможно, не ставить более 2 точных предметов: математика, физика, химия.
• BR-39. Физкультуру желательно не ставить первым уроком.
• BR-40. Использовать желательные предметы для первых уроков: чтение, математика. Применяется для 1–4 классов.
• BR-41. В четверг не ставить точные предметы — применяется в 1-х классах.
• BR-42. В четверг — минимальное количество уроков, применяется в 1-х классах.
• BR-43. Если нет свободных аудиторий, продолжительность прогулки может меняться.
• BR-44. Продолжительность прогулки может меняться, чтобы соответствовать расписанию столовой.

Проведение занятий, журнал и оценивание

План учителя и урок

• TR-1. Перед началом учебного семестра преподаватель планирует недельную часовую нагрузку. В результате получается учебный план на семестр, или план учителя, — последовательность проведения уроков с определёнными темами, практических занятий и контрольных работ.
• TR-2. Каждому академическому часу соответствует урок, который описывается датой проведения, порядковым номером, темой урока и подробным описанием того, что будет изучаться.
• TR-3. Уроку также соответствует домашнее задание, которое вносится во время учебного процесса. Это текстовое описание, которое может содержать текст, списки задач из учебника, прикреплённые файлы и URL.
• TR-4. Домашнее задание содержит задание, которое должно быть подготовлено к этому уроку.
• TR-5. Уроку может соответствовать контрольная работа. Контрольные работы в расписании должны выделяться дополнительными признаками.
• TR-6. Для классов с одинаковой часовой нагрузкой, когда совпадают базовая программа и дополнительный пакет, учебный план может быть одинаковым.
• TR-7. В течение учебного года темы и содержание фактически проведённых уроков могут не совпадать с запланированными.

Классный журнал и посещаемость

• TR-8. В классном журнале преподаватель фиксирует предметы, которые читает, учебный план, оценки, домашнее задание и посещаемость.
• TR-9. Преподаватель отмечает посещаемость по каждому предмету в классном журнале. Если ученик отсутствует, это соответствует отметке «Н».
• TR-15. После добавления оценки необходимо фиксировать дату и время, когда оценку внесли в классный журнал.
• TR-16. После фиксации оценки корректировка не допускается. Редактировать может только пользователь с ролью «Директор».
• TR-17. Добавление оценки в журнал за прошедшую дату невозможно.
• TR-18. За урок одному ученику может быть поставлена только одна оценка.

Оценки и исключения

• TR-10. Оценки ставятся числами от 1 до 12.
• TR-11. В 1–2 классах никакие оценки или «зачтено» / «не зачтено» не ставятся. Отмечается только посещаемость.
• TR-12. Оценки ставятся в 3–11 классах.
• TR-13. Есть исключения для предметов. Не ставятся оценки ученикам начальной школы (1–4 классы) по музыке, изобразительному искусству, физкультуре и трудовому обучению. По этим предметам ставится итоговая за семестры и итоговая за год в виде «зачтено» / «не зачтено». Для учеников 5–11 классов действует стандартное оценивание по 12-балльной системе.
• TR-14. Есть исключения для учеников 5–11 классов. Не ставятся оценки ученикам, у которых группа по физкультуре «специальная»: для них оценивание в виде «зачтено» / «не зачтено». Ученик относится к одной из групп: основная, подготовительная, специальная.
• TR-19. В журнале могут быть оценки, не привязанные к конкретной дате и уроку: тематическая оценка, оценка за тетрадь, итоговая оценка за семестр, предварительная оценка за год, скорректированная оценка, итоговая оценка за год.
• TR-20. При расчёте средних оценок округление происходит в пользу ученика.
• TR-21. Оценки за контрольные работы имеют такой же вес, как и остальные.
• TR-22. Тематическая оценка — средняя оценка за изученную тему. Рассчитывается автоматически, округление в пользу ученика. Суммируются все оценки за уроки, проведённые от предыдущей тематической оценки, включая оценки за тетрадь. Если предыдущей тематической оценки нет — от начала учебного года.
• TR-23. Тетрадь оценивает преподаватель. Этот вид оценивания есть только у предметов «украинский язык», «украинская литература» и «зарубежная литература».
• TR-24. Итоговая за семестр — средняя оценка, учитываются только тематические оценки. Рассчитывается автоматически, округление в пользу ученика.
• TR-25. Предварительная за год — средняя оценка, учитываются только оценки за семестр. Рассчитывается автоматически.
• TR-26. Скорректированная оценка — может быть поставлена по итогам возражений по предварительной оценке за год.
• TR-27. Итоговая за год — средняя оценка, учитываются оценки за семестр и скорректированная оценка.

Отчёт об успеваемости

• TR-28. В конце каждого месяца для ученика готовится «Отчёт об успеваемости» — краткая характеристика по каждому предмету. Включает список оценок и комментарий к каждому предмету, а также раздел «персональное развитие ученика».
• TR-29. Для 1–4 классов краткую характеристику каждому ученику по каждому предмету пишет закреплённый за классом учитель. По предметам, которые читают другие преподаватели, характеристики пишут соответствующие преподаватели.
• TR-30. Для 5–11 классов «Отчёт об успеваемости» пишут учителя-предметники, а раздел «персональное развитие ученика» — куратор.

Основные функции системы: рабочие места, пользователи и права

Правила предметной области дальше раскладываются на автоматизированные рабочие места (АРМ) — по ролям пользователей. Каждое АРМ работает через веб-интерфейс.

АРМ «Директор школы»

• Расписание уроков и звонков для всей школы.
• «Список сотрудников».
• «Личная карточка сотрудника».
• «Список классов».
• «Список учеников в классе».
• «Личное дело ученика».
• Доступ к «общешкольным документам».

АРМ «Делопроизводитель»

Отдельное рабочее место делопроизводителя (контент-менеджера) через веб-интерфейс.

АРМ «Преподаватель»

• План учителя.
• Занятия в классе.
• Расписание преподавателя.
• Система оповещений.
• Список классов.
• Ученики в классе.
• Личная карточка ученика.
• Обсуждение домашнего задания.

АРМ «Ученик»

• Расписание уроков ученика.
• Журнал оценок.
• Домашнее задание.
• Система сообщений.
• «Правила для ученика» — статическая страница, единая для всей школы, доступная для адаптивного просмотра.

АРМ «Родители»

• Расписание уроков ученика.
• Журнал оценок.
• Домашнее задание.
• Отчёт об успеваемости.
• Список преподавателей.
• Учебные планы (план учителя).
• Система сообщений.
• «Правила для ученика» — статическая страница, единая для всей школы, доступная для адаптивного просмотра.

АРМ «Куратор»

• Домашнее задание.
• Список преподавателей класса.
• Расписание уроков и звонков для класса.
• Электронный журнал.
• Отчёт об успеваемости ученика.

АРМ «Завуч»

Рабочее место, с которого настраивают параметры системы и формируют расписание на основе учебных планов.

Пользователи системы

Система прав и распределение пользователей по ролям

Такой формат ТЗ не отвечает на вопрос «как именно это будет выглядеть» — он отвечает на вопрос «по каким правилам это должно работать». Реализацию команда проектирует уже после того, как правила собраны, проверены и согласованы со школой.