матичний підхід, при якому кожна глава керівництва присвячена якійсь окремій темі, більше підходить для удосконалюються користувачів. В останньому, третьому підході, команди або завдання організовані у вигляді алфавітного довідника - часто це добре сприймається просунутими користувачами, які добре знають, що вони шукають. Скарги користувачів зазвичай ставляться до того, що документація охоплює тільки один з цих підходів, і тому добре підходить лише для одного класу користувачів.
Створення документації в EA
Говорячи про створення документів проекту, тут маються на увазі повні готові звіти, що містять секції, відформатовані і стилізовані за вимогами організації розробників. Вони включають всі вимоги, варіанти використання, технологічні процеси та діаграми.
Також містяться такі секції:
· Подробиці про версії
· Зв'язані документи
· Словник термінів
· Зміст
· Загальна інформація
· І другіепредоставляет три основних способи для генерації документів:
· Використання коду для створення документів
· Генерація секцій за допомогою RTF шаблони і подальше зведення в документ
· Генерація повного документа в EA за допомогою Моделі Документа
Докладніше розглянемо метод генерації документації у форматі RTF
RTF формат
документація програмний генерація користувальницький
Rich Text Format , RTF - пропріетарний міжплатформна формат зберігання розмічених текстових документів, запропонований групами програмістів, що заснували компанію Microsoft і Adobe , як мета-теговскій формат для редактора Word в 1982 році. З тих пір специфікація формату кілька разів змінювалася. RTF-документи підтримуються всіма сучасними текстовими процесорами.
Створення документів у форматі RTF
Architect може генерувати Rich-Text звіти для всього модельного пакета або для обраних результатів пошуку в моделі.
Щоб створити звіт для обраного пакета в Project Browser потрібно:
? Праве клацання миші на пакеті в Project Browser і вибрати Documentation | Text Documentation з контекстного меню, або:
? Select Project | Documentation | Rich Text Format Report з головного меню EA
? Використовувати гарячу клавішу F8 на клавіатурі.
Найпростіший процес отримання документа звідси:
. Вибрати шаблон (template) зі списку Use Template.
. Клікнути на Generate для створення документа.
. Використовувати кнопку View для перегляду результату.
Рис.1 - Створення документа
Головною особливістю цієї генерації і функціональності EA є використання настройки (customizing) звіту за допомогою вибору шаблону.
RTF шаблони
При створенні документа доступно безліч стандартних шаблонів. Один з них можна вибрати з відповідного списку.
