Система управления требованиями. Версия 0.3.

Руководство пользователя

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

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

Установка

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

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

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

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

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

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

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

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

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

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

Запуск программы для создания и редактирования списков статусов требований осуществляется командой:
java -cp RequiresO.jar m.requires.status.MReqStatusFrame

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

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

Запуск программы для создания и редактирования списков приоритетов требований осуществляется командой:
java -cp RequiresO.jar m.requires.priority.MReqPriorityFrame

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

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

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

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

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

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

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

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

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

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

Запуск программы для создания и редактирования списков статусов требований осуществляется командой:
java -cp ./RequiresO.jar m.requires.status.MReqStatusFrame

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

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

Запуск программы для создания и редактирования списков приоритетов требований осуществляется командой:
java -cp ./RequiresO.jar m.requires.priority.MReqPriorityFrame

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

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

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

Назначение

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

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

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

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

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

Примечание
Необходимо указывать расширение .xml в конце имени файла
Примечание
В диалоге используется фильтр для показа только файлов с расширением .xml. Если файл со списком типов требований имеет другое расширение, то необходимо в фильтре установить отображение всех файлов.
Примечание
Если требование имеет подчиненные требования, то оно отображается в дереве в виде узла. Узел может быть раскрыт (тогда подчиненные требования показаны) или закрыт (тогда подчиненные требования не видны). Если требование не имеет подчиненных требований, то оно отображается в дереве в виде листового элемента. Чтобы легче было различать в дереве не только типы требований, но и видеть наличие или отсутствие у них подчиненных требований, можно задать различные значки для раскрытого и закрытого узла и для листового элемента. В качестве значка может выступать любое изображение, сохраненное в виде графического файла. Желательно, чтобы размер значка был не очень большим, иначе он будет занимать слишком много места. Рекомендуемый размер значков 16x16 пикселов.

Примечание
Код типа присваивается при сохранении списка. Его не надо задавать вручную.

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

Описание

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

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

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

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

Примечание
Если в списке присутствуют статусы с одинаковым кодом, то будет выдано сообщение об ошибке и список сохранен не будет.

Примечание
Необходимо указывать расширение .xml в конце имени файла.
Примечание
В диалоге используется фильтр для показа только файлов с расширением .xml. Если файл со списком статусов требований имеет другое расширение, то необходимо в фильтре установить отображение всех файлов.
Примечание
Значек позволяет легко различать статусы требований в дереве. Желательно, чтобы размер значка был не очень большим, иначе он будет занимать слишком много места. Рекомендуемые размер значков 16x16 пикселов.
Примечание
В Windows не учитывается регистр букв в именах файлов, в Linux – учитывается. (В Linux "file.gif" и "File.gif" разные файлы, в Windows – один и тот же файл) Если Вы настроите список на компьютере с Windows, а затем перенесете его вместе с графическими файлами на компьютер с Linux, могут перестать отображаться значки, чьи имена были записаны не в том регистре.

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

Описание

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

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

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

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

Примечание
Если в списке присутствуют приоритеты с одинаковым кодом, то программа сообщит об ошибке и список сохранен не будет.
Примечание
Необходимо указывать расширение .xml вконце имени файла
Примечание
В диалоге используется фильтр для показа только файлов с расширением .xml. Если файл со списком приоритетов требований имеет другое расширение, то необходимо в фильтре установить отображение всех файлов.
Примечание
Значок позволяет легко различать приоритеты требований в дереве. Желательно, чтобы размер значка был не очень большим, иначе он будет занимать слишком много места. Рекомендуемый размер значков 16x16 пикселов.
Примечание
В Windows не учитывается регистр букв в именах файлов, в Linux – учитывается. (В Linux "file.gif" и "File.gif" разные файлы, в Windows – один и тот же файл) Если Вы настроите список на компьютере с Windows, а затем перенесете его вместе с графическими файлами на компьютер с Linux, могут перестать отображаться значки, чьи имена были записаны не в том регистре.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Меню. Проект.

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

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

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

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

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

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

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

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

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

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

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

Пример HTML документа с отдельным фреймом для оглавления

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

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

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

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

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

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

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

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