Это старая версия документа!
Содержание
Правила написания документации
Техническое задание
Формулировки
В Техническом задании используются формулировки вида "необходимо разработать", "требуется создать" и т.д. В Техническом задании не может быть скриншотов модуля.
Структура
В начале Технического задания необходимо описать цель создания модуля (зачем он будет использоваться).
Далее необходимо указать базовые доступы.
После этого необходимо описать все страницы, которые нужно создать.
Цель создания модуля, базовые доступы и каждую из страниц нужно делать заголовками, чтобы они автоматически подтягивались в оглавление.
Доступы
Доступы описываются в следующем формате:
Доступ к страницам модуля предоставляется: название_роли_или_группы - полный доступ (просмотр, администрирование групп учреждений, выгрузка в Excel); Остальные сотрудники ИНКОЦентра - доступ на просмотр и выгрузку в Excel. (и т.д.) Доступ для сотрудников Департамента культуры города Москвы не предусмотрен. Доступ для сотрудников учреждений не предусмотрен.
Принцип - перечислить все роли с подробным указанием, что им можно, а что нельзя.
Если кому-то из ИНКОЦентра, ДКгМ и учреждений доступ закрыт - указать, что он закрыт.
Руководство пользователя
Ссылка на модуль
В Руководстве пользователя должна быть прямая ссылка на модуль (если они разные для разных типов пользователей - то необходимо перечислить все), а также способ войти в модуль, начиная с главной страницы системы.
Доступы
Раздел "Доступы" должен быть продублирован из Технического задания и также находиться ближе к началу Руководства.
Разделение на блоки
Необходимо, как и в Техническом задании, не писать всю инструкцию единым монолитом текста, а разделять на смысловые блоки с заголовками, которые должны автоматически подтягиваться в оглавление.
Скриншоты
В Руководстве пользователя обязательно наличие скриншотов из модуля.
Программа испытаний
Первый сценарий
1-й сценарий должен проверять базовые доступы и возможности модуля. Т.е. необходимо перечислить попытки входа в модуль от имени пользователей как минимум следующих групп:
- Сотрудник ИНКОЦентра
- Сотрудник ДКгМ
- Сотрудник учреждения
Формулировки
Помните, что вы пишете не Положение об испытании, а Программу испытаний. Формулировки не должны быть абстрактными.
Не допускается формулировка вида "Результаты работы выводятся на экран". Примерные варианты более точных формулировок:
- Выводится полный перечень учреждений, выводятся столбцы (указать перечень столбцов) для 2019, 2020 и 2021 года.
- Выводится список заявок, отфильтрованный по театрам и концертным учреждениям.
- Отображается окно с информацией о помещении (адрес, площадь, вид права).
Не допускается формулировка вида "выбрать необходимую дату", "выбрать необходимый вид учреждения". Для даты необходимо указать конкретную дату в окрестности даты создания модуля (если по смыслу не требуется другая дата), т.е. правильная формулировка - "выбрать дату 01.06.2021". Для видов учреждения укажите "выбрать вид учреждения Театры". Если вы выбираете одно учреждение - укажите любое действующее на момент создания модуля учреждение, кроме ИНКОЦентра и управленческих учреждений. Если вы выбираете несколько учреждений поштучно, допускается написать "выбрать несколько учреждений", а в графе "Результат" - "информация по соответствующим учреждениям".
Стандартные используемые формулировки:
- Войти в систему как пользователь с ролью …
- Открывается/отображается страница …
- Пользователь перенаправляется на главную страницу КИС (нет доступа к запрашиваемой странице).
Результат
В графе "Результат" указываются:
- изменения в базе данных, если они произошли;
- отображаемая информация по результатам Действия;
- способ проверки изменений в базе данных, если они не содержатся в отображаемой информации.
Недостаточно указать "Заявка перешла в статус Выполнено". Необходимо добавить "На экране отображается статус заявки Выполнено".
