Reqeditor-getting-started » History » Version 37
Илья Рудаков, 12/17/2009 04:11 PM
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 | 33 | Илья Рудаков | <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 | 2 | Yuriy Shekochihin | Правый клик -> Импорт... |
70 | |||
71 | 35 | Илья Рудаков | h3. 2.4 Добавление выделенного текста из документа в требование |
72 | 1 | Yuriy Shekochihin | |
73 | 35 | Илья Рудаков | Выберите в Documents нужный вам документ и двойным щелчком мыши откройте его. Далее выделите текст в документе, как показано ниже. |
74 | |||
75 | !Req7.png! |
||
76 | |||
77 | После того как текст выделен нажмите правую кнопку мыши и выберете "Add to requirement...". |
||
78 | |||
79 | !Req9.png! |
||
80 | |||
81 | 37 | Илья Рудаков | Выбранный текст будет добавлен в требование и подсвечен желтым цветом в документе, как показано ниже. |
82 | 36 | Илья Рудаков | |
83 | !Req.png! |
||
84 | |||
85 | 2 | Yuriy Shekochihin | ** Выбрать документ |
86 | 1 | Yuriy Shekochihin | * Выделить нужный текст |
87 | * Добавить его в новое требование |
||
88 | * Добавить к существующему требованию новый текст |
||
89 | * Удалить старый текст из требования |
||
90 | |||
91 | 20 | Илья Рудаков | h3. 2.5 Работа с требованиями |
92 | 1 | Yuriy Shekochihin | |
93 | * Редактирование альтернативного описания требования |
||
94 | * Управление атрибутами требования |
||
95 | * Указание предиката требования |
||
96 | * Создание нового требования |
||
97 | * Удаление требования |
||
98 | |||
99 | 31 | Илья Рудаков | h2. 3. Генерация отчета |
100 | 9 | Yuriy Shekochihin | |
101 | 28 | Илья Рудаков | Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже. |
102 | |||
103 | 1 | Yuriy Shekochihin | !RepGen-call.png! |
104 | 9 | Yuriy Shekochihin | |
105 | 29 | Илья Рудаков | Появится диалоговое окно. |
106 | В нем четыре пункта для ввода: |
||
107 | # *Root* - определяет корневое требование в вашей иерархии требований; |
||
108 | # *Data* - путь к шаблону FreeMarker. Файл с расширением .ftl; |
||
109 | # *Template* - путь к файлу template.xml; |
||
110 | # *Save to* - путь к директории куда мы хотим сохранить получившийся отчет. |
||
111 | |||
112 | 8 | Yuriy Shekochihin | !RepGen-dialog.png! |