Документирование автоматизированных систем в соответствии с ГОСТ 34

I. Автоматизированная система и документация на нее

1. Автоматизированная система с точки зрения ГОСТ 34

Представление об АС. ГОСТ 34.003-90: формальное определение АС и его смысл. Классификация АС.

Представление о частях АС. Персонал, программы, оборудование; взаимосвязь между компонентами. Подсистемы. Виды обеспечения и комплектующие изделия АС.

Представление об автоматизируемой деятельности. Цели и функции АС. Задачи. Информационная модель, и/или бизнес-процессы.

Представление о порядке создания АС. ГОСТ 34.601-90: стадии создания АС, общий обзор.

2. Документация на АС с точки зрения ГОСТ 34

Формальные требования к документации. Системная документация и документация на комплектующие изделия. ГОСТ 34.201-89: типы и виды документов. Взаимосвязь стадий создания АС с документами. РД 50-34.698- 90: требования к содержанию документов. ГОСТ 2.105-95: требования к оформлению документов. Присвоение документам шифров и кодов. Комплексы стандартов ЕСПД и ЕСКД.

Принципы формирования комплекта документации. Техническая документация - инструмент, а не ритуал. Мотивы включения документа в комплект: в интересах заказчика и/или в интересах исполнителя, типичные потребности, удовлетворению которых служат документы. Обоснование состава комплекта документации перед заказчиком.

Сводные карты. Компоненты АС и области действия стандартов. Стадии создания АС, документы и требования к ним.

3. Документация разработки АС

Предпроектные стадии. Формирование требований к АС. Концепция АС. ГОСТ 7.32-2001: оформление результатов обследования и концепции. Техническое задание (ТЗ) на АС. Ключевая роль ТЗ при создании АС. ГОСТ 34.602-89: требования к содержанию ТЗ. Рекомендации по стилю изложения ТЗ.

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

Рабочая документация. Обзор документов стадии 'рабочая документация'. Документ 'Программа и методика испытаний' и его взаимосвязи с ТЗ. Проектно-сметная документация. Представление об исполнительной документации.

Сводные карты. Взаимосвязи между документами разных стадий. 'Обязательные' и 'необязательные' документы.

4. Эксплуатационная документация АС

Эксплуатационная документация (ЭД) и ее особенности. ЭД как часть АС. Формальные требования к ЭД.

Документация эксплуатационного персонала. Формуляр. Спецификация. Общее описание системы. Инструкция по эксплуатации КТС. Руководство системного программиста.

Документация пользователей. Руководство оператора. Руководство пользователя. Технологическая инструкция. Описания процессов. Поставка ЭД аудитории. Твердые копии и электронные документы. Форматы электронной документации.

Проектирование ЭД. Требования к полноте, профилированию, стилю изложения и другим трудно формализуемым свойствам ЭД. Анализ аудиторий и формирование комплекта ЭД. Стандарты ГОСТ Р ИСО/МЭК на документацию пользователя.

II. Организация документирования АС

5. Разработка технической документации в проекте

Формализация требований к документированию. Что должно быть указано в договоре на создание АС. Рекомендации по составлению раздела 'Требования к документированию' в техническом задании на АС: минимальный состав требований к технической документации.

Организация документирования в команде. Распределение обязанностей по подготовке документации различного типа между участниками проекта. Цикл подготовки документа. Планирование работ по документированию. Оценка сроков и трудоемкости. Типичные риски, связанные с подготовкой документации. Принципы обмена документами между Исполнителем и Заказчиком. Особенности разработки эксплуатационной документации. Непредусмотренные гостами, но важные документы. Устав проекта, книга проекта, отчет по проекту.

6. Технология разработки документации

Инвентарь разработчиков документации. Шаблоны, пустографки, примеры. Библиотека нормативно-технических документов. Типовые инструкции для участников проекта.

Взаимосвязи между документами и их использование. Разделы документов, состоящие в причинно-следственных, логических и текстуальных взаимосвязях. Формирование составление разделов документов последующих стадий на основе разделов документов предшествующих стадий. Microsoft Word, друг и враг разработчика документации. Технические риски при работе с документами Microsoft Word. Технические требования к документам в формате Microsoft Word.

Возможные альтернативы Microsoft Word. Представление о принципе единого источника. Технологические платформы и инструментальные средства: AuthorIT, DocBook/XML, DITA, Rational SoDA.

7. Типичные конфликты и способы их преодоления

Рассматриваются конфликты, возникающие между исполнителем и заказчиком особенно часто. Обсуждаются их причины и способы преодоления.

A) 'Давайте начнем программировать, а документацию сделаем позже!'

B) 'Прошло два месяца, а у нас вместо системы одна документация!'

C) 'Ваша документация никуда не годится!'

D) 'Вы сорвали жесткий срок, и поэтому:'

• Случай 1: ':вот вам новый, еще более жесткий!'
• Случай 2: ':давайте хотя бы работу сделаем нормально!'

E) 'Было не срочно, вдруг стало срочно'.

F) 'Тут вашу документацию Иван Иваныч посмотрел:'

• Случай 1: проходил случайно мимо один крупный специалист.
• Случай 2: VIP в засаде.
• Случай 3: неполное делегирование полномочий.

G) 'Каждый день что-нибудь новенькое'.

H) Неконструктивные упреки.

• 'Мы за вас эту документацию сами написали!'
• 'За это время мы бы все сделали своими силами!'