WYSIWYG-редактор

Работа с текстовыми проектными артефактами в Devprom ALM ничем не отличается от использования привычных текстовых процессоров. Над областью редактирования отображается панель инструментов мощного WYSIWYG-редактора, при помощи которого можно оформлять текст, вставлять таблицы, изображения, математические формулы, UML-модели, диаграммы и т.п.

Работа в режиме документа

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

Создание новых разделов осуществляется при помощи:

  • контекстного меню в Содержании;
  • ссылок "вставить требование" и "создать дочернее";
  • зеленой кнопки с символом "+"

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

Вы можете выбрать режим отображения документа:

  • только один раздел
  • или сразу несколько разделов

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

Чтобы сохранить эти настройки для данного представления, используйте штатную возможность - ссылку "сохранить", которая отобразиться в поле настроек фильтра.

Управление правками в документе

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

При помощи фильтра "Комментарии" вы можете отобразить только те разделы документа, по которым есть незавершенные комментарии, либо только ваши комментарии. Это существенно ускоряет процесс согласования документа.

Сигнализируйте о том, что комментарий учтен (реализован путем внесения изменений), либо более не актуален (если предоставлен исчерпывающий ответ), при помощи состояния комментария: завершен или открыт. Управление состоянием комментария доступно при помощи галочки на панели комментариев справа, либо при помощи контекстного меню на вкладке Комментарии на форме редактирования раздела документа.

Работа с внешними документами

При работе над проектами у вас могут быть внешние документы, полученные, например, от заказчика или других источников. Чтобы сохранить и использовать эти документы в проекте вы можете:

  • импортировать их, приложение поддерживает импорт из PDF, MSWord, OpenDocument, HTML, Excel;
  • приложить к разделам базы знаний или требований как файлы.

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

Импорт документов можно осуществлять внутрь конкретных разделов при помощи пункта "Создать" - "Дочернее" - "Импортировать":

Импортировать можно ранее экспортированный документ. В режиме документа, в меню "Действия" есть соответствующий пункт "Импортировать".

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

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

Работа с таблицами

Ширину столбцов в таблице можно фиксировать при помощи слайдеров. Создание/удаление столбцов или строк осуществляется при помощи контекстного меню.

Нумерация таблиц

Приложение позволяет автоматически нумеровать таблицы при экспорте во внешние документы (MSWord, OpenDocument и др.). Для этого необходимо открыть свойства таблицы и заполнить поле "Заголовок":

save image

Сверху таблицы появится поле для ввода названия таблицы. При экспорте документа во внешний формат, приложение автоматически пронумерует таблицы:

Работа с изображениями

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

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

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

Нумерация изображений

Приложение позволяет автоматически нумеровать изображения при выгрузке их во внешние документы (MSWord, OpenDocument и др.). Для добавления подписи к рисунку необходимо открыть свойства изображения в редакторе и на вкладке "Дополнительно" отметить галочку "Отображать название".

save image

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

save image

После выгрузки документации во внешние форматы, приложение автоматически пронумерует рисунки:

Поддержка моделирования

При подготовке проектной документации, например, бизнес- или системных требований, хорошо использовать различные выразительные инструменты - UML-модели, BPMN-диаграммы, макеты графического интерфейса, деревья решений (ментальный карты, mind maps) и т.п.

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

При нажатии на панели инструментов кнопки "Диаграмма", откроется популярный редактор draw.io, в котором вы можете создавать диаграммы совершенно различных нотаций. Это отличная альтернатива Visio и подобных настольных инструментов. Исходный код (текст) диаграммы хранится непосредственно внутри требования, так что работает версионирование, сравнение версий и другие механизмы управления требованиями и изменениями, используемыми для текста.

При необходимости вы можете создавать диаграммы при помощи настольной версии draw.io и затем импортировать их в документ.

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

На панели инструментов выберите кнопку "Вставить HTML" и вставьте в поле для ввода текст, который сообщил вам инструмент моделирования.

Вот перечень нескольких популярных инструментов для моделирования:

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

Ментальные карты (mind maps)

Для создания деревьев решений (ментальных карт) используйте диаграммы. Добавьте новую диаграмму и в разделе "Расширенные" выберите готовую фигуру "Mind maps".

Вы можете создавать ветви, топики и идеи при помощи стрелок на диаграмме:

Макеты графического интерфейса

Для создания макетов графического интерфейса вставьте диаграмму и выберите фигуры (Mockup...), в которых можно найти все основные элементы управления для макетирования пользовательского графического интерфейса. Если такой категории фигур нет, то нажмите кнопку "Больше фигур" и подключите необходимые категории.

Ссылки на проектные артефакты

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

Если название раздела или артефакта изменится, то название ссылки также изменится.

Чтобы добавить ссылку с нужным вам названием (текстом), то используйте штатные кнопки на панели инструментов редактора.

В качестве адреса ссылки можно указать ссылку на проектный артефакт.

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

Подстановка модуля или отчета

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

  • Release notes (заметки к релизу)
  • Перечень работ/задач, отмеченных тегом
  • План устранения рисков
  • Перечень связанных требований
  • Трассировка требований и т.д.

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

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

Оглавление

Специальный модуль "Содержание документа требований" позволяет вставить в страницу содержание (или оглавление) документа:

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

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

При задании формулы для вычисления значения атрибута используйте [ru_RU] Devprom ALM: Руководство пользователя / Синтаксис языка запросов (ru_RU). Формула должна содержаться в фигурных скобках, например

Например, для типового оформления требований мы предлагаем демонстрационный шаблон, в котором отображаются его атрибуты:

Повторное использование текста

Добавляйте заранее подготовленные тексты в пару кликов. Используйте настройку "Шаблоны текста" для создании заранее заготовленных текстов, которые затем можно подставлять в редактор путем ввода символа "решетка" (#). Таким образом, можно организовать подстановку шаблона для историй, требований или типовых ответов в комментариях.

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

На форме выбора текста артефакта предусмотрено поле "Спойлер", которое позволяет скрыть текст внутри раскрывающегося по клику элемента управления:

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

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

Для создания типовых документов с предварительно заполненной структурой и содержанием некоторых разделов используйте действие "Сохранить как шаблон":

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

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

Таким же образом удобно декомпозировать импортированные требования на дочерние (атомарные) требования. Достаточно выделить необходимый текст и выбрать действие "Создать требование":

Вставка медиаконтента

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

Выгрузка во внешние форматы

Подготовленные вами документы могут быть выгружены во внешние форматы, такие как MSWord, OpenDocument, PDF, HTML. При выгрузке в MSWord, вы можете использовать образец (шаблон) документа, в который необходимо выгрузить текст. В образце документа могут быть объявлены стили, добавлены колонтитулы, титульные листы и т.п.

Технически, для выгрузки документов в формат PDF, MSWord или OpenDocument используются бесплатные внешние инструменты: Imagick, PanDoc или LibreOffice (OpenOffice). Доступность операций выгрузки определяется наличием этих компонентов на сервере, где установлен Devprom ALM. Проверьте наличие установленного LibreOffice на сервере. Если по каким-то причинам данное приложение использовать невозможно, то установите на сервер PanDoc.

Опции выгрузки

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

Повторный импорт документа

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

Операция доступна в кнопке "Действия" в режиме работы с документом.

Селективная выгрузка

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

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

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

Выгрузка атрибутов документа в шаблоне

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

{$Название$}

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

Пользовательские стили

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

В файл htdocs/conf/plugins/wrtfckeditor/custom.css необходимо добавить такие строки:

.wysiwyg ol {
    counter-reset: item;
}

.wysiwyg li {
    display: block;
}

.wysiwyg li:before {
    content: counters(item, ".") " ";
    counter-increment: item
}