Тема 14. Публикация документов

Мадорская Ю.М.

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

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

Документы могут понадобится для согласования результатов разработки требований и проектирования с теми, кому мы по каким-то причинам не хотим предоставлять доступ в Cradle, например, с заказчиком.

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

Каждый раз меня поражает один эффект — легко работая с требованиями в Cradle, только после публикации документа осознаешь, какой реально огромный объем данных ты разработал. В Cradle этого как-то не замечаешь, настолько его аналитические представления облегчают восприятие большого количества взаимосвязанных элементов.

Самые простые документы можно получить просто щелкнув правой кнопкой мыши по любому представлению и нажав «Опубликовать». Это позволяет «выкинуть» любое открытое представление в rtf или html или csv.

Если нужны документы посложнее, содержащие сборку проектных данных из разных разделов, в индивидуальном оформлении, то здесь уже необходимо использовать Document Publisher.

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

Полезно знать, что в Cradle есть два режима публикации документов «Как черновик» и «Формальный (официальный) документ».

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

Таким образом, в сумме с возможностями Document Loader, которые мы рассмотрели ранее, обеспечивается сквозная трассируемость требований/проектных данных: исходный документ->проектные данные в базе->итоговый документ с точностью до версии каждого требования.

Какие документы можно публиковать? Тут вы ограничены только собственной фантазией и потребностями вашего тех. процесса. Кроме всем очевидного ТЗ, это могут быть: устав проекта, план управления рисками, спефицикации требований разных уровней, повестка рабочей встречи и т.д..

Если мы возьмем другую предметную область, например, СМК. Это могут быть: политика в области качества, руководство по качеству, модели тех. процессов, результаты аудитов и т.п.

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

В демо-проекте есть пример публикации документа — с панели фаз можно запустить узел Documentation -> Requirements Specification Document.  Это большой документ, содержащий текст, таблицы, диаграммы, поэтому необходимо подождать, пока все данные будут «вытянуты» из базы, отформатированы нужным образом и вставлены в документ. После публикации появится сообщение о том, что публикация завершена и документ сам откроется.

Ниже несколько иллюстраций.

Панель фаз демо-проекта и фаза, нажав на которую можно запустить публикацию демо-документа

phase_panel

После запуска публикации с панели фаз, внизу высветится фраза:

publishing

После завершения публикации появится сообщение:

finished

И откроется опубликованный документ:

word

Другие примеры шаблонов документов можно найти в проектах/схемах, которые есть на сайте центра компетенций http://cradle.saturs.ru/category/project-templates/