Requality

h1. Requality: глоссарий

*Проект Requality* - проект Eclipse, созданный с помощью плагина Requality. Cодержит документы, требования отчеты, комментарии.

*Документ* – это документ некоторого формата, содержащий требования, написанные в свободной форме. В документе пользователь выделяет фрагменты текста и присваивает их требованиям.

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

*Выделенный фрагмент документа* – это часть документа, которая была отмечена пользователем как принадлежащая какому-либо требованию.

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

*Комментарий* - объект, содержащий некоторый текстовый комментарий и относящийся к требованию или тестовой ситуации. У одного требования (одной тестовой ситуации) может быть несколько комментариев.

*RequalityExplorer* - окно в перспективе Requality, отображающее все содержимое проекта (документы, требования, отчеты и т.д.).

*Markup Editor* - окно в перспективе Requality, редактор документов, используется для разметки фрагментов требований в документах.

*UniEditor* - окно в перспективе Requality, визуальный редактор для требований, тестовых ситуаций и комментариев.

*Properties* - окно в перспективе Requality, отображает свойства выбранного объекта (требования, документа, тестовой ситуации, отчета, комментария) .

*Параметры требования* - свойства требования, которые устанавливаются в окне ''Properties''.

Для требований окно ''Properties'' содержит 4 вкладки:

# *Вкладка Main* содержит следующие параметры требования

## *Id* – идентификатор требования. Идентификатор уникален среди детей одного родителя. Может быть отредактирован вручную.

## *Name* – имя требования. Может не быть уникальным. Совпадает с идентификатором, если не задано отдельно. Может быть отредактировано вручную.

## *Attributes* – атрибуты требования. По умолчанию наследуются от родительских требований, но могут быть переопределены. Применяются в предикатах. Заполняются вручную.

!ReqPropertiesMain.png!

# *Вкладка Description* содержит следующие параметры требования

## *Alternative description* – альтернативный текст требования, уточняет и дополняет текст выделенных фрагментов. Заполняется вручную.

## *Locations* - список выделенных фрагментов данного требования, сгруппированный по документам. Вручную не редактируется.

!ReqPropertiesDescription.png!

# *Вкладка Advanced* содержит следующие параметры требования

## *Predicate* – предикат, условие отбора требований для отчетов. По умолчанию наследуется от родительских требований. Заполняется вручную.

## *Base requirements* – базовые требования. Требования, которые наследует и расширяет данное требование. Указываются вручную.

!ReqPropertiesAdvanced.png!

# *Вкладка Source* содержит только json-код

## *json* – низкоуровневое представление требования как сущности. Не редактируется.

!ReqPropertiesSource.png!

*Параметры отчета* - свойства отчета, которые указываются в окне ''Properties''.

Для отчетов окно ''Properties'' содержит 2 вкладки:

# *Вкладка Report Data*

## *Root requirement* – требование, для которого создается отчет. В отчет войдет это требование-узел и все его дочерние узлы (требования и комментарии). В случае подключения дополнительных плагинов к Requality в отчет могут войти и узлы других типов. Редактируется вручную.

## *Template* – шаблон, по которому будет формироваться отчет. Редактируется вручную - выбирается из списка возможных шаблонов. По умолчанию доступен только шаблон ''Requirements''. При добавлении собственных шаблонов или использовании дополнительных плагинов к Requality список доступных шаблонов может быть расширен.

## *Attributes* – атрибуты отчета, аналогичны атрибутам требования. По умолчанию включает один дополнительный атрибут – ''date'' – дата и время генерации последнего отчета. Атрибут пересоздается каждый раз при генерации отчета. Таблица атрибутов редактируется вручную.

# *Вкладка Source* содержит только json-код

## *json* – низкоуровневое представление отчета как сущности. Не редактируется.

*Outline* - окно в перспективе Requality, отображающее список фграгментов документа.

*Подтребование, дочернее требование* - это требование, являющееся дочерним узлом другого требования в иерархии проекта.

*Шаблон отчетов* - шаблон, в соответствии с которым модифицируется вид и содержимое отчета. Например, данные можно представить в виде списка или таблицы. Включить в отчет все узлы дерева Requirements или только узлы некоторого конкретного типа. В случае использования плагинов к Requality список доступных шаблонов может пополняться. Вы также можете самостоятельно создавать нужные шаблоны.

*Шаблон отчетов Requirements* - шаблон, который позволяет создать отчет с перечислением всех требований, удовлетворяющих заданному предикату.

*Шаблон отчетов Test Purposes Coverage* - шаблон, который позволяет создать отчет, содержащий все тестовые ситуации и статистическую информацию об их состоянии.