Обзор системы

Что такое архитектура

Шаблон представления

Каталог представлений

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

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

Каждому представлению, отраженному в комплекте документации, в каталоге представлений соответствует отдельная запись. Любая запись состоит из нескольких элементов:

1) имя представления и обозначение стиля, который оно иллюстрирует;

2) описание типов элементов, отношений и свойств представления;

3) описание назначения представления;

4) управляющая информация о документации представления: указание его последней версии, местоположения и владельца.

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

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

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

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

Дата добавления: 2015-04-25