Инструменты пользователя

Инструменты сайта


documentation:rules

Это старая версия документа!


Правила написания документации

Техническое задание

Формулировки

В Техническом задании используются формулировки вида "необходимо разработать", "требуется создать" и т.д. В Техническом задании не может быть скриншотов модуля.

Структура

В начале Технического задания необходимо описать цель создания модуля (зачем он будет использоваться).
Далее необходимо указать базовые доступы.
После этого необходимо описать все страницы, которые нужно создать.
Цель создания модуля, базовые доступы и каждую из страниц нужно делать заголовками, чтобы они автоматически подтягивались в оглавление.

Доступы

Доступы описываются в следующем формате:

Доступ к страницам модуля предоставляется:
название_роли_или_группы - полный доступ (просмотр, администрирование групп учреждений, выгрузка в Excel);
Остальные сотрудники ИНКОЦентра - доступ на просмотр и выгрузку в Excel.
(и т.д.)
Доступ для сотрудников Департамента культуры города Москвы не предусмотрен.
Доступ для сотрудников учреждений не предусмотрен.

Принцип - перечислить все роли с подробным указанием, что им можно, а что нельзя.
Если кому-то из ИНКОЦентра, ДКгМ и учреждений доступ закрыт - указать, что он закрыт.

Руководство пользователя

Ссылка на модуль

В Руководстве пользователя должна быть прямая ссылка на модуль (если они разные для разных типов пользователей - то необходимо перечислить все), а также способ войти в модуль, начиная с главной страницы системы.

Доступы

Раздел "Доступы" должен быть продублирован из Технического задания и также находиться ближе к началу Руководства.

Разделение на блоки

Необходимо, как и в Техническом задании, не писать всю инструкцию единым монолитом текста, а разделять на смысловые блоки с заголовками, которые должны автоматически подтягиваться в оглавление.

Скриншоты

В Руководстве пользователя обязательно наличие скриншотов из модуля.

Программа испытаний

1-й сценарий должен проверять базовые доступы и возможности модуля. Т.е. необходимо перечислить попытки входа в модуль от имени пользователей как минимум следующих групп:

Стандартные используемые формулировки: - "Войти в систему как пользователь с ролью …"

Протокол испытаний

documentation/rules.1626426476.txt.gz · Последнее изменение: admin

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki