Документы и реестр
С требованиями удобно работать как в форме документа, так и в форме произвольного набора атомарных требований (при помощи реестра или списка требований). Например, в виде документа может быть оформлено ТЗ или ЧТЗ. Однако, такие документы получаются большими и целиком их не реализуют. Реестр позволяет работать только с нужным подмножеством атомарных требований - оценивать, планировать, контролировать реализацию.
У документарного и спискового представления реестра есть свои плюсы и минусы:
| Плюсы | Минусы | |
| Документ требований |
На одном экране видны связанные друг с другом разделы документа. Цельное описание задачи. Можно выставлять/контролировать требования к полноте, непротиворечивости. Удобно согласовывать. Можно версионировать и создавать бейзлайны. |
Сложные системы состоят из тысяч требований, работать с которыми при помощи документа становится невозможным. Итерационная разработка предполагает реализацию требований частями. Группы требований могут состоять из участков документа, размещенных в разных его частях - попробуй, собери это в кучу. |
| Реестр (список) требований |
Нет избытка информации (текста требований) при работе с атрибутами или связями требований. Можно быстро выполнять массовые операции: оценка, реализация. Легко контролировать трассировки на исходные/производные требования, на покрывающие артефакты: тестовую документацию, тесты, техническую документацию и т.п. |
На произвольном наборе требований невозможно проверить полноту непротиворечивость и целостность документации и продукта. Разные требования как правило семантически связаны между собой, но по одному лишь требованию этого нельзя проследить - нужны структурные связи, которые дает документарное представление. |
Для выполнения различных задач по документированию и управлению, выбирайте наиболее подходящее представление работы с документами, Devprom ALM поддерживает их все.
Импорт/экспорт и печать
Загрузите ваши документы с требованиями в формате MSWord, OpenDocument или Excel. Приложение автоматически разберет их на разделы в соответствии со структурой, заданной в документе. Для разделения документа на требования используется разметка заголовочными стилями (Заголовок 1, Заголовок 2 и т.п.).
Пользовательская разметка документов
Вы можете самостоятельно реализовать логику конвертации импортируемого документа в требования. Для этого можно использовать Автоматические действия вместе со скриптами автоматизации. При импорте каждого раздела система выполнит ваш скрипт, который может проанализировать состав раздела и выделить в нем требования, классифицировать их, создать и добавить ссылки на них.
Например, для преобразования текста, содержащего фразу "Системное требование" в системные требования и сохранении ссылки на эти требования в разделе документа, вы можете разработать такой скрипт:
В результате импорта документа система создаст системные требования, а ссылки на них разместит в документе требований:
Экспорт во внешние форматы
Вы можете выгружать произвольный набор требований, документ или несколько документов во внешние форматы. При выгрузке в MSWord вы можете указать шаблон (заготовку) документа, стили которого будут использованы при выгрузке. В этом шаблоне могут присутствовать титульные листы, то есть выгрузка может осуществляться в любое место в шаблоне. При помощи макросов WYSIWYG-редактора вы можете выгружать атрибуты документа и конкретных требований, например, выгрузить название документа в определенное место в шаблоне.
Перечень ранее использованных шаблонов для экспорта можно найти в настройках проекта, в модуле "Шаблоны выгрузки". В процессе "Разработка по требованиям" содержится пример выгрузки документов в шаблон по требованиям ГОСТ. Вы можете самостоятельно задавать формат формирования маркированных и нумерованных списков, для чего предназначены соответствующие поля в Шаблоне выгрузке на вкладке Дополнительно.
Для повторного импорта документов, измененных заинтересованными лицами вне системы, используйте опцию выгрузки "Экспортировать исходный код UML-моделей и формул". Таким образом, после импорта эти объекты вновь станут редактируемыми, так как при экспорте они преобразуются в изображения.
Для импорта откройте документ и в меню Действия выберите соответствующий пункт меню.
Если необходимо распечатать несколько разделов или целый документ, можно воспользоваться встроенными возможностями печати из браузера:
Виды связей
Требования могут быть связаны с другими требованиями или другими проектными артефактами.
| Вид связи | Назначение |
| Структурная, родитель-ребенок |
Сложные требования удобно декомпозировать на более мелкие кусочки. Для варианта использования дочерними требованиями могут являться: макеты UI, точки расширения (альтернативные сценарии или расширяющие сценарии), системные требования. Требования могут образовывать иерархию, формируя тем самым документ, спецификацию или ТЗ. Для быстрой декомпозиции требования на составные части создавайте дочерние требования на основе выделенного фрагмента текста:
|
| Причинно-следственная |
В общем виде, на основе бизнес-требований создаются функциональные требования (например, в формате вариантов использования). На основе функциональных - системные. Это причинно-следственные связи, которые позволяют проследить (трассировать) переход с одного уровня абстракций до другого и так до программного кода.
|
| Зависимости |
Некоторые требования могут включать в свой текст содержание других требований, либо ссылаться на другие требования. Такие ссылки называются "зависимости" и позволяют выявлять требования, на которые ссылаются другие требования (перед модификацией или удалением).
|
| Покрытие | Такой тип связи устанавливается между требованиями и другими проектными артефактами: тестовой документацией и технической документацией (руководствами пользователей). |
Создание связей осуществляется прозрачно для пользователя, при создании проектных артефактов на основе первичных, бизнес- или системных требований (например, при помощи зеленых кнопок или пунктов меню). Связи можно редактировать на вкладке "Трассировки".
Связи можно визуализировать на сетевой диаграмме (на вкладке Связи):
Отслеживаемость между требованиями (причинно-следственные связи) и между требованиями и другими проектными артефактами (покрытия) используется в Devprom ALM как инструмент поддержания целостности проектной документации. Когда исходное требование изменяет текст, то система помечает все производные требования и покрытия признаком "Устарело". Устаревшие требования и другие артефакты можно легко найти и обновить, чтобы восстановить целостность связи.
Шаблоны
Шаблоны требований - это типовые заготовки, которые можно использовать при документировании требований. Шаблоны вставляются при указании символа # (решетка). Если шаблон определен как шаблон по умолчанию, то при создании требования будет сразу подставлен этот шаблон. Для разных типов требований можно использовать разные шаблоны по умолчанию. Мы уже включили в типовые процессы несколько распространенных шаблонов, но вы их можете удалить и использовать собственные наработки.
Помимо шаблонов страниц, вы можете формировать шаблоны документов. Например, это может быть типовой документ для создания ТЗ или спецификации по тому образцу, который принят в вашей организации. Для создания шаблона импортируйте вашу заготовку в Devprom ALM или наберите структуру средствами приложения. В меню "Действия" в режиме работы с документом выберите "Создать шаблон". Для создания документа по шаблону используйте кнопки с их названиями:
Переиспользование
Повторное использование требований возможно реализовать несколькими способами.
Вынесите общие требования в программу проектов. В подпроектах можно ссылаться на них или детализировать эти общие требования.
Чтобы создать копию документа с требованиями в другом проекте, достаточно выбрать пункт "Дублировать" в меню "Действия" в режиме работы с документом. В реестре требований любой куст или требование можно скопировать (продублировать) в текущий или другой проект при помощи действия "Копировать".
Если требование повторно используется в нескольких документах, то можно включить это требование в нужный раздел документа. Операция доступна из контекстного меню для требования, а также как массовая операция в реестре требований.
Если текст какого-то требования должен повторяться в тексте других требований, используйте возможность редактора WYSIWYG вставлять в текст требования текст другого проектного артефакта. Данная возможность доступна при помощи кнопки на панели инструментов или через контекстное меню в редакторе WYSIWYG.
Чтобы вставить сразу несколько требований в другой документ, откройте реестр требований и отметьте их галочками, затем при помощи массовых операций добавьте эти требования в выбранный или новый документ.