Найти тему

Шаблон пользовательской истории: описание пользовательского интерфейса

Описание пользовательского интерфейса состоит из макета с отмеченными на нем цифрами элементами (используется программа Screenpresso), которые добавлены или изменены в рамках реализации текущей пользовательской истории, а так же таблицы описаний этих элементов.

Изображение сопровождается подписью в формате "Рис." с порядковым номером и названием, точно отражающим содержимое макета или его отдельного фрагмента. Подпись выделяется курсивом и выравнивается по центру. Формат подписи: Рис. N. <Название изображения>. Название начинается с нового предложения и отделяется от номера точкой.

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

Таблица состоит из столбцов:

1. Номер по порядку

2. Название элемента

3. Описание

4. Взаимодействие с пользователем

5. Локализация (RU)

6. Шаг Use Case

Столбец «Название элемента» содержит обозначение элемента, которое позволяет однозначно идентифицировать элемент в тексте документа, оставаясь при этом кратким и информативным относительно его назначения, понятным для всех сторон (аналитика, заказчика, разработчика, тестировщика).

Столбец "Описание" детализирует, как элемент формируется или заполняется на backend. Указывается, из каких атрибутов или ссылки на алгоритмы (алгоритмы размещены в разделе "Подфункции" или "Дополнительная информация").

Столбец "Взаимодействие с пользователем" описывает реакцию интерфейса на действия пользователя, включая динамическое изменение внешнего вида интерфейса (frontend-логику), включая такие аспекты как проверки по маске, подсветку ошибок, автоматическое обновление данных, фильтрацию и сортировку, разблокировку неактивных элементов, которые происходят в реальном времени без перезагрузки страницы. Может включать отсылки на более подробные алгоритмы действий (алгоритмы размещены в разделе "Подфункции" или "Дополнительная информация").

Столбец "Локализация (RU)" содержит текст, отображаемый на frontend для текущего элемента пользовательского интерфейса.

Столбец "Шаг Use Case" содержит номер шага, к которому относится элемент, или ссылку на сценарий использования целиком. Взаимодействие с пользователем может быть описано в виде одного или нескольких таких сценариев.