Project

General

Profile

Reqeditor-getting-started » History » Version 55

Илья Рудаков, 12/21/2009 11:31 AM

1 15 Илья Рудаков
h1. Getting started with ReqEditor
2 1 Yuriy Shekochihin
3 4 Yuriy Shekochihin
ReqEditor является инструментом для организации каталога требований. Этот инструмент выполнен в виде расширения для Eclipse. 
4 2 Yuriy Shekochihin
5
Найти подробную информацию о ReqEditor можно по адресу: http://forge.ispras.ru/projects/show/reqdb
6
7 30 Илья Рудаков
h2. 1. Установка
8 1 Yuriy Shekochihin
9 5 Yuriy Shekochihin
Для работы ReqEditor требуется установленный Eclipse. Если у Вас уже установлен Eclispe следующий пункт можно пропустить.
10
11 16 Илья Рудаков
h3. 1.1 Системные требования
12 1 Yuriy Shekochihin
13 2 Yuriy Shekochihin
* Firefox 3.5 или выше;
14
* Eclipse 3.5 или выше;
15
16 16 Илья Рудаков
h3. 1.2 Установка Eclipse
17 1 Yuriy Shekochihin
18 30 Илья Рудаков
Eclipse можно скачать, зайдя на сайт http://eclipse.org/
19 2 Yuriy Shekochihin
20 16 Илья Рудаков
h3. 1.3 Установка ReqEditor
21 2 Yuriy Shekochihin
22 32 Илья Рудаков
Для установки ReqEditor необходимо скачать последнюю версию расширения с "сайта проекта":http://forge.ispras.ru/projects/list_files/reqdb и распаковать архив в директорию: 
23 51 Yuriy Shekochihin
<pre>%ECLIPSE%/dropinst</pre> где %%ECLIPSE%% - путь к Eclipse IDE.
24 1 Yuriy Shekochihin
25 19 Илья Рудаков
26 21 Илья Рудаков
h2. 2. Разметка требований
27 20 Илья Рудаков
28 34 Илья Рудаков
Рассмотрим подробнее работу инструмента на примере требований к функции g_array_sized_new()
29 2 Yuriy Shekochihin
библиотеки glib.
30
31 20 Илья Рудаков
h3. 2.1 Подготовка к работе
32 1 Yuriy Shekochihin
33 23 Илья Рудаков
Перед началом работы необходимо открыть вкладки Documents и Requirements. Для этого нужно открыть Window -> Show View -> Other, как показано на следующем рисунке.
34 1 Yuriy Shekochihin
35
!Views-menu-path.png!
36 23 Илья Рудаков
37
Перед вами появится диалоговое окно. Выберите Requirement Editor -> Requirements.
38 11 Yuriy Shekochihin
39
!Views-show-reqs.png!
40
41 24 Илья Рудаков
Повторите туже операцию, но теперь выберете Documents.
42
43 11 Yuriy Shekochihin
!Views-show-docs.png!
44 24 Илья Рудаков
45
После выполнения данных операций в основном окне Eclipse появятся две вкладки: Requirements и Documents. В первой вкладке будет отображаться иерархия требований, во второй - документы. Расположите эти вкладки так, как вам будет удобно. Например, как на рисунке ниже.
46 11 Yuriy Shekochihin
47
!Views-result.png!
48
49 20 Илья Рудаков
h3. 2.2 Создание нового каталога
50 1 Yuriy Shekochihin
51 26 Илья Рудаков
Теперь нам нужно создать каталог требований. Под каталогом требований мы будем понимать контейнер, в котором хранятся документы и требования. Чтобы создать каталог требований, зайдите в File -> New -> Other, как показано ниже.
52 25 Илья Рудаков
53 1 Yuriy Shekochihin
!Catalog-call-wizards.png!
54 26 Илья Рудаков
55 27 Илья Рудаков
Вы увидите диалоговое окно. Выберите Unitesk Wizards -> Catalogue of Requirements  и нажмите Next.
56 10 Yuriy Shekochihin
57 1 Yuriy Shekochihin
!Catalog-select-wizard.png!
58 27 Илья Рудаков
59
В следующем диалоговом окне нужно указать имя каталога. В нашем примере мы назвали его "Glib-Catalogue". Жмем Finish.
60 9 Yuriy Shekochihin
61
!Catalog-_wizard_creates_new_cat.png!
62
63 12 Yuriy Shekochihin
В итоге должно получиться следующее:
64
65
!cat-after-creation.png!
66
67 20 Илья Рудаков
h3. 2.3 Импорт документа в каталог
68 1 Yuriy Shekochihin
69 53 Илья Рудаков
Теперь нам нужно добавить документ в каталог. Для этого в Requirements нажимаем правой кнопкой мыши на каталог требований "Glib-Catalogue". В появившемся меню выбираем "Import here".
70
71 52 Илья Рудаков
!Doc-import-call.png!
72 53 Илья Рудаков
73 55 Илья Рудаков
В диалоговом окне в поле "Import file:" указываем путь к документу с помощью кнопки "Browse...". В нашем примере это "glib-Arrays.html":http://forge.ispras.ru/attachments/100/glib-Arrays.html.
74 53 Илья Рудаков
В поле "Save to:" при помощи кнопки "Browse..." указываем путь к папке Documents, которая находится в каталоге требований "Glib-Catalogue".
75
76 54 Илья Рудаков
!Doc-import-dialog.png!
77 53 Илья Рудаков
78
Чтобы открыть документ, добавленный в каталог требований, нужно двойным щелчком мыши нажать на название документа в отображении Documents, как показано ниже. Чтобы функционал разметки документа работал, важно открывать документы именно через отображение "Documents", а не через отображение "Project Explorer"!
79
80 52 Илья Рудаков
!Doc-open.png!
81 2 Yuriy Shekochihin
82 40 Илья Рудаков
h3. 2.4 Создание требований
83 1 Yuriy Shekochihin
84 42 Илья Рудаков
Теперь давайте создадим простую иерархию требований. Для этого перейдем в "Requirements", выделим каталог требований "Glib-Catalogue" и нажмем на правую кнопку мыши. Далее нажимаем на "Add requirement", как показано ниже.
85 40 Илья Рудаков
86 1 Yuriy Shekochihin
!Req-new-call.png!
87 42 Илья Рудаков
88
Появится диалоговое окно, в котором нужно указать имя требования. В нашем примере это "g_array_sized_new".
89
90 1 Yuriy Shekochihin
!Req-set-name.png!
91 42 Илья Рудаков
92
Следующий шаг - аналогичным образом добавим дочерние требования с именами: "01", "02", "03" и "04" к "g_array_sized_new". 
93
94 41 Илья Рудаков
!Req-new-call2.png!
95 40 Илья Рудаков
96
h3. 2.5 Добавление выделенного текста из документа в требование
97
98 35 Илья Рудаков
Выберите в Documents нужный вам документ и двойным щелчком мыши откройте его. Далее выделите текст в документе, как показано ниже.
99
100
!Req7.png!
101
102
После того как текст выделен нажмите правую кнопку мыши и выберете "Add to requirement...".
103
104
!Req9.png!
105
106 38 Илья Рудаков
Появится диалоговое окно, в котором вы можете выбрать к какому требованию добавить выделенный текст. В нашем примере мы добавляем текст к требованию g_array_sized_new.01.
107
108
!Req-select.png!
109
110 49 Илья Рудаков
После нажатия кнопки "OK", выбранный текст будет подсвечен желтым цветом в документе, как показано ниже.
111 36 Илья Рудаков
112 1 Yuriy Shekochihin
!Req.png!
113 49 Илья Рудаков
114 50 Илья Рудаков
Аналогичным образом размечаем еще три текстовых сегмента и добавляем их в требования g_array_sized_new.02, -03 и -04 соответственно. Сохраняем документ. После сохранения все размеченные текстовые фрагменты будут добавлены в базу требований.
115 49 Илья Рудаков
116
!Doc-save.png!
117 36 Илья Рудаков
118 43 Илья Рудаков
h3. 2.6 Удаление размеченного текста из требования
119 1 Yuriy Shekochihin
120 43 Илья Рудаков
Чтобы удалить размеченный текст из требования, достаточно один раз кликнуть мышью по тексту. Текст поменяет цвет с желтого на розовый. Это значит, что вы, таким образом, выбрали именно этот участок текста.
121 44 Илья Рудаков
После этого нажмите правую кнопку мыши и выберите "Remove from requirement".
122
123
!Req10.png!
124 43 Илья Рудаков
125 45 Илья Рудаков
h3. 2.7 Редактирование требований
126 1 Yuriy Shekochihin
127 47 Илья Рудаков
Чтобы открыть окно редактирования требования, нужно в Requirements выбрать нужное требование и двойным щелчком мыши его открыть.
128
В открывшемся окне вы увидите раздел "Main information". Здесь указана информация об id требования, об всех размеченных текстовых фрагментах из документа( поле "Description" ) и т.д.
129
130 1 Yuriy Shekochihin
!Req11.png!
131 47 Илья Рудаков
132
Вы можете добавить к требованию альтернативное описание в поле "Alternative description".
133
134 1 Yuriy Shekochihin
!Req-edit-desc.png!
135
136 48 Илья Рудаков
Так же, в графе "Additional information" вы можете добавить предикаты и атрибуты.
137 47 Илья Рудаков
138
!Req-erit-attr-pred.png!
139 9 Yuriy Shekochihin
140 28 Илья Рудаков
h2. 3. Генерация отчета
141
142 1 Yuriy Shekochihin
Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже.
143 9 Yuriy Shekochihin
144 29 Илья Рудаков
!RepGen-call.png!
145
146
Появится диалоговое окно. 
147
В нем четыре пункта для ввода:
148
# *Root* - определяет корневое требование в вашей иерархии требований;
149
# *Data* - путь к шаблону FreeMarker. Файл с расширением .ftl;
150
# *Template* - путь к файлу template.xml;
151 8 Yuriy Shekochihin
# *Save to* - путь к директории куда мы хотим сохранить получившийся отчет.
152 1 Yuriy Shekochihin
153
!RepGen-dialog.png!