На основе моделей Capella необходимо уметь генерировать документацию в формате MS Word. Стандартный дополнительный компонент Capella позволяет генерировать только гипертекстовую документацию в формате HTML. Данный компонент необходимо устанавливать дополнительно после установки Capella
Для генерации документации в формате MS Word необходимо использовать универсальный компонент Eclipse Gendoc , позволяющий генерировать документацию в форматах MS Word и OpenOffice на основе любых EMF моделей, в том числе на основе моделей Capella. С использование GenDoc шаблоны документов создаются с помощью MS Word (или Open Office) и языка для создания шаблонов Acceleo.
Для генерации документации на основе моделей Capella можно использовать и просто Acceleo (см. пост). Однако, сгенерировать документацию в формате Word используя просто Acceleo будет не так просто.
Преимущество использования GenDoc состоит в том, что появляется возможность разработать шаблоны документов непосредственно в Word и форматировать документ необходимым образом с использованием средств Word.
Есть и неудобство от использования GenDoc. При разработке шаблонов приходится использовать яызк Acceleo без подсветки синтаксиса и без контекстной подсказки по API и элементам мета-модели. Если сравнить работу с Acceleo в специализированном редакторе Eclipse, то это очень большое неудобство. С этим неудобством получается справиться, используя интерактивное окно запросов в Capella, которое позволяет выполнять Acceleo запросы к модели. При разработке шаблона документа приходится постоянно проверять запросы элементов в окне запросов и только потом вставлять их в шаблон.
Устанавливать GenDoc в Capella нужно по инструкции на форуме (используя версию GenDoc с форума)
По этой же ссылке есть пример шаблона для GenDoc. Попробовать его можно на модели
In-Flight Entertainment (IDE) Sample Model
Документация поGenDoc доступна по ссылке
Для своих целей я создал отельные шаблоны GenDoc для каждого типа моделей в Capella
- System Analysis
- Logical Architecture
- Physical Architecture
И генерирую отдельные документы для каждой из этих моделей.
Ниже скриншоты моих документов, которые я генерирую c использованием GenDoc.
Комментариев нет:
Отправить комментарий