Главная страница 
 
О Фонде ФОСТАС 
События 
Семинары 
Конференции 
Программы и Проекты 
Библиотека 
Тезисы 
Доклады 
Материалы проектов 
Презентации 
Об участии 
Работа участников 
Вопросы-ответы 
Контакты 
Форум 
 

Критерии поиска:

в разделе библиотеки:

 


РАЗРАБОТКА КОРПОРАТИВНЫХ СТАНДАРТОВ ДОКУМЕНТИРОВАНИЯ

БАРТЕНЕВА МАРИЯ ЮРЬЕВНА, СУББОТИН АЛЕКСЕЙ ВИКТОРОВИЧ

"ЮНИС лаб", Москва

Любая автоматизированная система (АС) включает в себя комплект документации, определяющей различные свойства АС. Однако, обеспечение полноты и непротиворечивости комплекта документации является крайне трудоемкой задачей. Документацию и АС разрабатывают разные люди, что приводит к неактуальности используемой документации. Этот доклад посвящен подходу к документированию, обеспечивающему получение качественной документации и поддержку ее в актуальном состоянии.

Существует несколько групп ГОСТ, определяющих требования к составу и содержанию документации на АС (ЕСКД, ЕСПД, Комплекс НД на АС). Выбор между этими стандартами неоднозначен и определяется как особенностями разрабатываемой АС, так и используемыми технологиями разработки. Если разрабатывать все документы, описываемые в различных ГОСТ, то результатом будет набор по разному оформленных и частично пересекающихся документов. Многие современные технологии разработки определяют свой набор документов. При этом большая часть информации может храниться в моделях АС или в различных БД используемых CASE-средств (например, при использовании Rational Unified Process требования могут хранится в БД Rational RequisitePro). Если процесс документирования неправильно поставлен, то эта информация при разработке документации может быть просто потеряна или ее придется синхронизировать с документацией вручную.

В этом докладе рассматривается подход к разработке документации, основанный на использовании концептуальной модели документации, определяющей элементы модели АС, структуру документации и связи между ними. Концептуальная модель может быть оформлена в виде корпоративного стандарта по документированию АС, который должен соблюдаться при разработке любых документов на АС. Документация АС создается по разработанной модели АС на основе заранее построенной концептуальной модели документации. Использование модели как «промежуточного» звена между АС и документацией позволяет отделить информацию о системе от способа представления этой информации. В модели АС информация не дублируется, что позволяет обеспечить единое отражение этой информации во всех разделах документа, где она должна содержаться.

Концептуальная модель документации включает в себя три части.

  • Концептуальная модель системы - определяет типы объектов документирования, существующих в системе, и их свойства. Например, объектами документирования в АС являются: АС, Таблица БД, Программный комплекс, Пользователь, Аппаратная платформа, Процесс ОС и др. Свойствами этих объектов могут быть: структура, характеристики качества, стоимость, а также отношения с другими типами объектов документирования.
  • Модель системы документации - определяет типы документов (например, Описание организационной структуры, Ведомость покупных изделий), структуру документов, требования к содержанию каждого раздела и стили оформления. Эта модель представляется в виде набора диаграмм классов, определяющих отношения "наследования" и "включения" между отдельными типами документов, и комплекта шаблонов (или текстового описания требований к содержанию) для каждого типа документа. Модель может основываться на любом стандарте, определяющем документацию АС.
  • Отображение между Концептуальной моделью системы и Моделью системы документации - определяет, какие документируемые свойства системы, в каких разделах, каких документов и каким образом отображаются. Например, документируемое свойство Архитектура системы описывается в Общем описании системы в разделе Общие положения с использованием диаграмм классов и текста.

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

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

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

Использование предлагаемого подхода подразумевает определенную дисциплину как при моделировании АС, так и при разработке документации, однако при этом возникают дополнительные возможности.

  1. Обеспечение качества разработанного комплекта документации. Проверка на полноту, непротиворечивость, согласованность со стандартами.
  2. Организация Системы управления изменениями в документации для обеспечения своевременного обновления документации при изменениях системы (изменения отслеживаются от АС к ее модели и уже от модели АС к документации, по зафиксированному отображению.
  3. Сокращение трудозатрат на разработку и сопровождение документации.
  4. Организация семантического поиска в БД документов на основе связи между разделами документа и элементами концептуальной модели.

Предлагаемый подход может использоваться при разработке документации на любые виды АС и при разработке любых других комплектов документации (например, управленческой документации). Различие только в содержании Концептуальной модели документации.

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

Назад

 


© 2002 FOSTAS Foundation
Главная страница > Библиотека Карта сайта
Дизайн — Лаборатория НТР