Создание документации в среде Enterprise Architect

МИНИСТЕРСТВО  ОБРАЗОВАНИЯ РЕСПУБЛИКИ БЕЛАРУСЬ

БЕЛОРУССКИЙ ГОСУДАРСТВЕННЫЙ  УНИВЕРСИТЕТ

 

Факультет прикладной математики и информатики 

Кафедра информационных систем управления

 

 

 

 

РЕФЕРАТ

по дисциплине “Технология программирования”

 

на тему:

“Создание документации в среде Enterprise Architect”

 

 

 

 

 

 

 

 

Выполнил:

4 курс 2 группа

 

Проверила:

доцент кафедры ИСУ

 

 

Минск 2012

 

Содержание

 

 

 

Введение

 

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

Важным направлением является развитие создание автоматической генерации  документации программных систем из средств проектирования и моделирования. Набор UML инструментов для анализа и дизайна на всех стадиях разработки программного обеспечения Enterprise Architect компании Sparx Systems обладает функциональностью для генерации документов для разрабатываемой ситемы..

Enterprise Architect предоставляет мощный механизм для генерации высококачественных настраиваемых документов прямо из UML модели. Когда EA был полностью выпущен, включая генерацию документов для проектов, для многих пользователей возможность надежно создавать проектную документацию стала в первую очередь главной особенностью этого инструмента.

В данном реферате будет рассматриваться  один из способов создания документации с помощью Enterprise Architect – генерация документа в формате RTF.

 

Документация

 

 

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

Документ — элемент документации: целевая информация, предназначенная для конкретной аудитории, размещенная на конкретном носителе (например, в книге, на диске, в краткой справочной карте) в заданном формате.

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

Типы документации

 

Существует четыре основных типа документации на ПО:

• архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО
• техническая — документация на код, алгоритмы, интерфейсы, API
• пользовательская — руководства для конечных пользователей, администраторов системы и другого персонала
• маркетинговая

 

Архитектурная/проектная документация

 Проектная документация обычно описывает продукт в общих чертах. Не описывая того, как что-либо будет использоваться, она скорее отвечает на вопрос «почему именно так?» Например, в проектном документе программист может описать обоснование того, почему структуры данных организованы именно таким образом. Описываются причины, почему какой-либо класс сконструирован определённым образом, выделяются паттерны, в некоторых случаях даже даются идеи как можно будет выполнить улучшения в дальнейшем. Ничего из этого не входит в техническую или пользовательскую документацию, но всё это действительно важно для проекта.

 

Техническая документация 

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

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

Часто при  составлении технической документации используются автоматизированные средства — генераторы документации, такие как Doxygen, javadoc, NDoc и другие. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML.

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

 

 

Пользовательская документация

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

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

Обычно, пользовательская документация представляет собой руководство пользователя, которое описывает каждую функцию программы, а также шаги, которые нужно выполнить для использования этой функции. Хорошая пользовательская документация идёт ещё дальше и предоставляет инструкции о том что делать в случае возникновения проблем. Очень важно, чтобы документация не вводила в заблуждение и была актуальной. Руководство должно иметь чёткую структуру; очень полезно, если имеется сквозной предметный указатель. Логическая связность и простота также имеют большое значение.

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

 

Создание документации в EA

Говоря о создании документов проекта, здесь имеются ввиду полные готовые отчеты, содержащие секции, отформатированные и стилизованные по требованиям организации разработчиков для их проектов. Они включают все требования, варианты использования (use cases), технологические процессы и диаграммы (process flows and diagrams).

Также содержатся следующие секции:

• Подробности о версиях
• Связанные документы
• Словарь терминов
• Содержание
• Общая информация
• И другие

 

EA предоставляет три главных метода для генерации документов:

• Использование кода для создания документов
• Генерация секций с помощью RTF шаблоны и последующее сведение в документ
• Генерация полного документа в EA с помощью Модели Документа

 

Подробнее рассмотрим метод генерации  документации в формате RTF

RTF формат

Rich Text Format, RTF (англ. rich — богатый; «формат обогащённого текста») — проприетарный межплатформенный формат хранения размеченных текстовых документов, предложенный группами программистов, основавшими компанииMicrosoft и Adobe, как мета-тэговский формат для редактора Word в 1982 году. С тех пор спецификация формата несколько раз изменялась. RTF-документы поддерживаются всеми современными текстовыми процессорами.

 

Создание документов в формате  RTF

Enterprise Architect может генерировать Rich-Text отчеты для всего модельного пакета или для выбранных результатов поиска в модели.

Чтобы создать отчет для выбранного пакета в Project Browser нужно:

♦ Правый щелчок мыши на пакете в Project Browser  и выбрать Documentation |

Rich Text Documentation из контекстного меню, или:

♦ Select Project | Documentation | Rich Text Format Report из главного меню EA

♦ Использовать горячую клавишу F8 на клавиатуре.

Самый простой процесс получения  документа отсюда:

1. Выбрать шаблон(template) из выпадающего списка Use Template. 

2. Кликнуть на Generate для создания документа.

3. Использовать кнопку View для просмотра результата.

 

Рис.1 – Создание документа

    

Главной особенностью этой генерации и функциональности EA является использование настройки (customizing) отчета с помощью выбора шаблона.

 

RTF шаблоны

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

Также можно использовать собственные  шаблоны. Для создания нового шаблона  нужно перейти на вкладку  Templates (шаблоны) и нажать на кнопку New (новый), или на вкладке Generate выбрать из списка <new template>.

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

 

 

Рис.2 – Список пользовательских шаблонов 

 

Рис.3 – Окно редактора шаблонов

 

Создание нового шаблона вызывает редактор шаблонов (Template Editor). В этом редакторе выполняется настройка создаваемого RTF-шаблона (выбор генерируемых секций, настройка и формирование содержимого итогового документа, …).

 

Заключение

 

Sparx Systems Enterprise Architect предоставляет широкие возможности для создания проектной документации, в частности с помощью RTF-шаблонов для генерации документов. Шаблоны являются мощным инструментов для настройки пользовательских требований и стилизации документации программного продукта.

 

Используемая литература

 

1. http://www.uml2.ru/
2. http://www.sparxsystems.com
3. Ross Park, Using Enterprise Architect for Project Documentation, 2011 http://community.sparxsystems.com
4. Dermot O’Bryan, Working with the RTF Generator, 2009 http://www.sparxsystems.com.au
5. http://www.wikipedia.org/