Система управления требованиями. Версия 0.9 Руководство пользователя

Краткое описание

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

Установка

Требования к системе

Компьютер с установленной Java версии 1.6 или выше.
Свободное место на жестком диске не менее 3,5 MB (без учета места для JRE).

Установка программ

Для установки программы необходимо распаковать архив и скопировать файлы в любую подходящую директорию.

Запуск программ в операционной системе Windows

Запуск программы для работы с требованиями осуществляется командой:
java -jar amRequires.jar
Чтобы каждый раз не набирать команду вручную, создан файл Req.bat. Запускайте этот файл для старта программы.

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указать директорию, в которой находится исполняемый файл java.exe нужной версии. Например:
"C:\Program Files\Java\jre1.6.0\bin\java" -jar amRequires.jar.
В этом случае необходимо также отредактировать файл Req.bat – добавить путь к исполняемому файлу.

Запуск программы для создания и редактирования списков типов требований осуществляется командой:
java -cp amRequires.jar m.req.type.MReqTypeFrameXML

Для облегчения запуска программы создан файл ReqTypes.bat.

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указывать директорию, в которой находится исполняемый файл java.exe нужной версии и отредактировать файл ReqTypes.bat.

Запуск программы для создания и редактирования списков атрибутов требований осуществляется командой:
java -cp amRequires.jar m.req.attribute.MReqAttributeTypeFrameXML

Для облегчения запуска программы создан файл ReqAttributes.bat.

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указывать директорию, в которой находится исполняемый файл java.exe нужной версии и отредактировать файл ReqAttributes.bat.

Запуск программ в операционной системе Linux

Запуск программы для работы с требованиями осуществляется командой:
java -jar ./amRequires.jar

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

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указать директорию, в которой находится исполняемый файл java нужной версии. Например:
/usr/java/jre1.6.0_05/bin/java -jar ./amRequires.jar

В этом случае необходимо также отредактировать файл Req.bat – добавить путь к исполняемому файлу.

Запуск программы для создания и редактирования списков типов требований осуществляется командой:
java -cp ./amRequires.jar m.req.type.MReqTypeFrameXML

Для облегчения запуска программы создан файл ReqTypes.bat.

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указывать директорию, в которой находится исполняемый файл java нужной версии и отредактировать файл ReqTypes.bat.

Запуск программы для создания и редактирования списков атрибутов требований осуществляется командой:
java -cp ./amRequires.jar m.req.attribute.MReqAttributeTypeFrameXML

Для облегчения запуска программы создан файл ReqAttributes.bat.

Если в Вашей системе Java версии 1.6 не установлена как используемая по умолчанию, то для запуска программы необходимо явно указывать директорию, в которой находится исполняемый файл java нужной версии и отредактировать файл ReqAttributes.bat.

Программа для редактирования списка типов атрибутов

Программа для редактирования списка типов атрибутов

Назначение

Программа предназначена для создания списков типов атрибутов требований, которые могут добавляться в различные типы требований. В предыдущей версии программы было 7 типов атрибутов: Начиная с этой версии каждое требование имеет следующие обязательные атрибуты: Пользователь может создавать свои типы атрибутов и добавлять их в разные типы требований. Для каждого типа атрибутов указывается: Для списочных типов задаются возможные значения. Для каждого значения можно задать изображение, которое будет отображаться в дереве требований.
При наличии признака отображения в таблице требований, значение соответствующего атрибута будет отображаться в табличном представлении проекта. Порядок столбцов в таблице требований соответствует порядку, в котором были расположены типы атрибутов в программе для настройки. Ниже приведен пример таблицы требований для списка атрибутов, показанного выше.

Пример таблицы требований

В директории Samples расположен файл ReqAttributes.rat с примером набора атрибутов требований.

Добавление типа атрибута

Чтобы добавить тип атрибута щелкните по кнопке с наименованием типа данных. В таблицу будет добавлена запись с соответствующим типом. Вы можете ввести наименование атрибута, комментарий и указать необходимость отображения атрибута в таблице. Менять тип данных нельзя.

Настройка последовательности атрибутов в таблице требований

Удаление типа атрибута

Добавление значения списочного типа атрибута

Удаление значения списочного типа атрибута

Настройка последовательности значений в списке

Отмена изменений

Чтобы отменить последнее сделанное изменение выберите пункт меню «Правка->Отменить» или нажмите сочетание клавиш CTRL+Z.

Повтор изменений

Чтобы выполнить последнее отмененное изменение выберите пункт меню «Правка->Повторить» или нажмите сочетание клавиш CTRL+Y.

Сохранение списка типов атрибутов

Примечание
Необходимо указывать расширение .rat или .xml в конце имени файла со списком типов атрибутов

Загрузка списка типов атрибутов

Выход из программы настройки списка типов атрибутов

Чтобы закрыть программу выберите пункт меню «Файл->Закрыть» или щелкните по кнопке в верхнем правом углу окна.

Вывод сообщений

Cообщения выводятся в текстовое поле, расположенное в нижней части окна программы. Граница между полем для сообщений и остальной частью окна подвижная. Ее можно передвигать с помощью мыши, нажав и удерживая левую кнопку.

Программа для редактирования списка типов требований

Назначение

Программа предназначена для создания списков типов требований, которые в последствии будут использоваться при разработке требований. Вместе с системой управления требованиями поставляется предварительно подготовленный список типов требований \Samples\ReqTypes.rt. Но он может не подойти всем пользователям. С помощью данной программы Вы сможете создать свои списки типов, полностью отвечающие Вашим потребностям.

Описание программы

Программа позволяет добавлять, изменять и удалять типы требований из списка. Для каждого типа задаются название, описание и значек, который будет отображаться в дереве требований основной программы. Кроме того для каждого типа требований может быть задан свой набор атрибутов. Созданный список сохраняется в XML файле. Все сообщения программы выводятся в текстовое поле, расположенное в нижней части окна программы. Граница между полем для сообщений и остальной частью окна подвижная. Ее можно передвигать с помощью мыши, нажав и удерживая левую кнопку.

На рисунке показан внешний вид программы.

Окно программы для создания списков типов требований

Создание списка типов требований

Стартовый диалог программы настройки типов требований

Загрузка списка типов требований

Примечание
В диалоге используется фильтры для показа только файлов с расширением .rt или .xml. Если файл со списком типов требований имеет другое расширение, то необходимо в фильтре установить отображение всех файлов.

Сохранение списка типов требований

Примечание
Необходимо указывать расширение .rt или .xml в конце имени файла

Добавление типа

Для разных типов требований можно установить префиксы идентификаторов требований. Если префикс установлен, то он будет отображаться перед идентификатором требования.
Например, uc_ - префикс варианта использования -> uc_101 - идентификатор варианта использования, u_ - префикс пользовательского требования -> u_32 - идентификатор пользовательского требования.

Изменение типа

Удаление типа

Настройка последовательности типов требований

Добавление атрибута в список атрибутов типа требования

Удаление атрибута из списка атрибутов типа требования

Настройка последовательности атрибутов в списке атрибутов типа требования

Редактирование общего списка типов атрибутов

Вы можите изменять общий список типов атрибутов, отображенный на панели в нижней части окна. Редактирование осуществляется так же как и в программе для настройки списка типов атрибутов, описанной выше. Есть только одно отличие - нельзя удалять типы атрибутов из общего списка.

Отмена изменений

Чтобы отменить последнее сделанное изменение нажмите кнопку Отменить или выберите пункт меню «Правка->Отменить» или нажмите сочетание клавиш CTRL+Z.

Повтор изменений

Чтобы выполнить последнее отмененное изменение нажмите кнопку Повторить или выберите пункт меню «Правка->Повторить» или нажмите сочетание клавиш CTRL+Y.

Программа для управления требованиями

Общее описание

Программа для управления требованиями предназначена для облегчения труда специалистов, занимающихся разработкой требований к различным системам. Данная программа является однопользовательской и ориентирована в первую очередь на разработчиков, работающих над проектами в одиночку, и на небольшие коллективы разработчиков, в которых управлением требованиями занимается один человек. Эта программа позволяет:

Старт программы

После запуска программы выдается окно с тремя закладками.

Стартовое окно программы. Последние проекты.

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

Стартовое окно программы. Открыть проект.

На второй закладке находится диалог для загрузки файла проекта.

Стартовое окно программы. Новый проект.

Третья закладка предназначена для создания нового проекта. На ней расположен диалог для выбора файла со списком типов требований и их атрибутами, которые будут использоваться в новом проекте. DIV class="note">

Формат файлов созданных в предыдущих версиях программы отличается от формата файлов, создаваемых в этой версии. Тем не менее старые файлы можно открывать в новой версии программы. Но файлы, сохраненные в новой версии программы, нельзя открыть в старых программах.

Описание основного окна программы

Основное окно программы делится на три части.

Основное окно программы

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

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

В нижней части окна находится текстовое поле для вывода сообщений.

Границы между частями подвижные. Вы можете установить их так, как Вам удобно. Для этого нужно захватить (нажать и удерживать кнопку мыши) границу, перетащить ее мышью на новое место и отпустить кнопку мыши.

Создание проекта

Диалог выбора файла с описанием типов требований

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

Сохранение проекта

Примечание
Выбрать пункт меню «Проект->Сохранить» можно, нажав одновременно клавиши Ctrl и S.

Диалог сохранения проекта

Сохранение проекта в другом файле

Открытие проекта

Примечание
По умолчанию на закладке «Открыть проект» используется фильтр, показывающий только файлы с расширением «.req». Так же можно установить фильтр для файлов с расширением «.xml». Если проект сохранен в файле с другим расширением, то, чтобы увидеть его в списке, необходимо изменить фильтр на «Все файлы» (All Files).
Формат файлов созданных в предыдущих версиях программы отличается от формата файлов, создаваемых в этой версии. Тем не менее старые файлы можно открывать в новой версии программы. Но файлы, сохраненные в новой версии программы, нельзя открыть в старых программах.

Экспорт требования

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

Чтобы экспортировать требование:

Импорт требований

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

Чтобы импортировать проект требований:

Импорт требований

Создание требования

Примечание
Активным является требование, которое выделено в дереве требований (или таблице) и чьи атрибуты отображаются в правой части окна программы. Чтобы сделать требование активным, щелкните по соответствующему узлу в дереве левой кнопкой мыши, или с помощью кнопок «Вверх» «Вниз» на клавиатуре переместите выделение на требуемый узел дерева или строку таблицы.

Кнопки управления требованиями

Изменение требования

Перемещение требования

Всплывающее меню

Примечание
В отличии от перемещения с помощью кнопок «Переместить требование вниз» и «Переместить требование вверх», которые позволяют переместить требование в пределах одного уровня иерархии, мышью можно переместить требование к любому родителю.

Удаление требования

Ссылки на требования

Отдельные требования могут быть связаны между собой. Например, вариант использования может описывать как будет реализовано пользовательское требование или вариант использования обобщенного уровня может ссылаться на варианты использования пользовательского уровня.

Для того, чтобы легче было отслеживать подобные связи в программе предусмотрено создание ссылок между требованиями. В панели атрибутов требования расположены таблицы со ссылками на требования, на которые ссылается данное (исходящие ссылки), и ссылками, указывающими на данное требование (входящие ссылки). В таблицах отображаются название и тип , а так же время последнего изменения требования, на которое указывает ссылка. Так же в таблицах отображается статус ссылки и время изменения ссылки.

При создании ссылка имеет статус «Проверена». Если требование, на которое указывает ссылка будет изменено, то статус изменится на «Требование изменено» и цвет фона изменится на желтый. После того, как Вы проверите не повлияло ли изменение требования на то, на которое указывает ссылка, и при необходимости внесете изменения, можно вернуть статус ссылки «Проверена». Для этого выделите ссылку и нажмите кнопку «Проверена».

Создание ссылки на требование

Переход к требованию по ссылке

Переход возможен как по исходящей, так и по входящей ссылке.

Удаление ссылки на требования

Ссылки на файлы

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

Создание ссылки на файл

Удаление ссылки на файл

Открытие прикрепленного файла

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

Создание текстового файла с описанием требований

Программа позволяет создавать по разному оформленные HTML файлы:
С фреймом
HTML документ будет содержать два фрейма: в левом будет отображаться оглавление, в правом - основной текст.
Единый текст
Если включен такой режим, то основной текст в правом фрейме будет представлен в виде одного файла. В противном случае для каждого требования будет создан отдельный файл. Первый вариант удобнее, когда необходимо последовательно читать текст требований, в этом случае можно будет пользоваться прокруткой. Во втором случае переходить от одного требования к другому можно будет только с помощью оглавления, расположенного в левом фрейме. Этот вариант может быть удобнее при работе с очень большим документом, когда нужно посмотреть лишь несколько требований и есть ограничения по скорости загрузки файлов.
Единый
Создается один HTML файл, содержащий оглавление и основной текст.
Тип оглавления - таблица
Оглавление представлено в виде таблицы, каждая строка которой содержит идентификатор, наименование и тип требования.
Тип оглавления - список
Оглавление представлено в виде простого списка наименований требований.

Поиск требования в дереве

Примечание
Описание регулярных выражений можно посмотреть в википедии на
ru.wikipedia.org

Отмена изменений

Чтобы отменить последнее сделанное изменение нажмите кнопку Отменить или выберите пункт меню «Правка->Отменить».

Повтор изменений

Чтобы выполнить последнее отмененное изменение нажмите кнопку Повторить или выбирите пункт меню «Правка->Повторить».

Изменение стиля интерфейса

Можно изменять внешний вид окон и элементов управления в них. Для этого откройте пункт меню «Настройки->Стили интерфейса» и выберите один из стилей, поддерживаемый Вашим компьютером.

Настройка списка типов требований и их атрибутов

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

Описание текстового редактора

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

Текстовый редактор

Назначение кнопок и списков показано на рисунке.

Редактор имеет два режима: встроенный и в отдельном окне. В последнем случае можно изменять размеры поля редактирования, что делает работу с текстом более удобной. Переключение между режимами осуществляется с помощью крайней левой кнопки в панели инструментов редактора .

Действие кнопок H3, H4, P аналогично использованию одноименных тэгов в HTML.

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

Проверка орфографии

Поля "Название" и описание требования поддерживают проверку орфографии. Слова с ошибками выделяются цветом фона.
Проверку орфографии можно включать и отключать с помощью пункта меню «Настройки->Проверять орфографию»

Изменение словаря

Для проверки орфографии используется словарь из файла russian.dic. Если слова нет в словаре, то оно отмечается как ошибочное. Вы также можете отредактировать файл russian.dic.