Requality

h1. Разметка требований

Инструмент Requality разрабатывался как средство автоматизированного извлечения требований из документации. Результатом работы программы является  база требований - древовидное представление требований с ссылкой к тексту документации.

Для создания базы требований необходимо создать проект, который будет содержать базу требований. Импортировать документацию в проект, а затем либо «руками» либо с помощью обработчика документа разметить документацию, отмечая в ней требования к системе.

h2. Создание проекта базы требований

Для создания проекта нужно выбрать в оконном меню пункт "File" -> "New" -> "Project..."

В появившемся диалоговом окне выбрать "Requality" -> "Requality Project" и нажать кнопку "Next".

!newproject01.png!

На следующей странице введите название проекта и нажмите кнопку "Finish".

!newproject02.png!

h2. Создание папок документов

Для удобства работы с документами внутри узла Documents можно создавать папки и размещать документы в них.

Для создания папки документов нужно выделить узел Documents или любую другую вложенную папку, в контекстном меню выбрать "Create Folder".

!createfolder01.png!

В появившемся диалоговом окне "New Document Folder" ввести имя создаваемой папки.

!createfolder02.png!

Нажать OK.

!createfolder03.png!

h2. Импорт документа

Requality позволяет импортировать сразу несколько документов.

Для импорта документа нужно выделить узел с пиктограммой папки. В контекстном меню выбрать «Import Document...».

!importdocument01.png!

Откроется диалоговое окно "Document Import Wizard". В нем нужно с помощью кнопки "Browse..." указать директорию, в которой находятся сами документы, содержащие требования, или папки с этими документами.

!importdocument02.png!

В окне "Select folders" нужно выбрать папку, в которой находится нужный документ (документы). При этом в окне "Select documents" отобразятся все документы, содержащиеся в этой папке, здесь следует выбрать (отметить галочкой) нужные документы.

!importdocument03.png!

Ниже находится поле "Import folder:". В нем нужно указать папку проекта, в которую будут добавлены выбранные документы. По умолчанию в этом поле указана папка "Documents" - корневая папка документов в проекте Requality. Но с помощью кнопки "Browse..." возле этого поля можно выбрать или создать другую папку.

!importdocument04.png!

После выбора целевой папки нужно в окне "Document Import Wizard" нажать Finish. 

!importdocument05.png!

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

!importdocument06.png!

h2. Ручная разметка требований

Под разметкой требований понимается выделение требований из текста документа. С одним требованием может быть связанно несколько частей документа. Работа с документами производится в редакторе разметки. Для этого нужно, выбрав нужный документ в "Requirement Base Explorer", открыть его двойным щелчком мыши. Откроется редактор разметки.

!add.to.requirement.png!

Для создания требования выполните следующие действия:

* выделите часть текста, которая содержит требование;

* нажмите на выделенном тексте правой кнопкой мыши и в контекстном меню выберете «Add to requirement...»;

* в диалоговом окне укажите узел, к которому будет добавлен отмеченный текст (при необходимости узел можно создать нажав на кнопку "create new").