Пояснительная записка к техническому проекту согласно госту. Техническая документация Пояснительная записка к проекту гост 34

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

Пояснительная записка является одним из важнейших документов технического проекта. Технический проект разрабатывают с целью выявления окончательных технических решений, дающих полное представление о конструкции изделия.
При разработке программы для создания пояснительной записки рекомендуется использовать ГОСТ 19.404-79 «Пояснительная записка. Требования к содержанию и оформлению» .

Для создания пояснительной записки к техническому проекту, описывающему автоматизированную систему (АС) рекомендуется использовать стандарт РД 50-34.698-90 «Автоматизированные системы. Требования к содержанию документов» .

Многие разделы, приведенных документов, перекликаются, поэтому мы для примера рассмотрим документ Пояснительная записка, созданный на основании РД 50-34.698-90

1 Общие положения

1.1 Наименование проектируемой АС

Данный раздел документа Пояснительная записка содержит полное и краткое наименование АС.

Например: «В данном документе создаваемая система называется Корпоративный Информационный Портал. Также допускается использование сокращенного наименования КИП или Система ».

1.2 Документы, на основании которых ведется проектирование системы

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

1.3 Организации, участвующих в разработке системы

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

1.4 Цели разработки АС

В данном разделе документа Пояснительная записка следует указать техническую, экономическую и производственную пользу, которую получит заказчик после внедрения, разрабатываемой системы.

Например: «Целью, создаваемой системы является:

оптимизация документооборота компании;
поддержка корпоративной культуры компании;
оптимизация коммуникаций между сотрудниками компании. »

1.5 Назначение и область использования разрабатываемой АС

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

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

Создание конференций для обсуждения вопросов;
Отправка/Получение электронных почтовых сообщений;
Обеспечение совместной работы над документами;
Согласование документов;
Ведение учета входящей и исходящей документации.»

1.6 Сведения об использованных при проектировании нормативно-технических документах

В данном разделе следует указать стандарты, которые использовались при создании документа Пояснительная записка.

Например: «При проектировании использовались следующие нормативно-технические документы:

ГОСТ 34.201-89 «Информационная технология. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначения документов при создании автоматизированных систем»;
ГОСТ 34.602-89 «Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы»;
ГОСТ 34.003-90 «Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения»;
ГОСТ 34.601-90 «Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания»;
РД 50-682-89 «Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Общие положения»;
РД 50-680-88 «Методические указания. Автоматизированные системы. Основные положения»;
РД 50-34.698-90 «Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов».»

1.7. Очередность создания системы

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

Например: «Реализация проекта Корпоративного информационного Портала планируется в две очереди.

Первая очередь КИП включает организации совместной работы сотрудников компании благодря введению таких возможностей как:

Обмен мгновенными сообщениями;
Организация конференции;
Передача/прием электронной почты;
Согласование документов средствами Системы.»

2 Описание процесса деятельности

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

Для иллюстрации материала в пояснительной записке допускается использовать нотации UML , ARIS или IDF0, а также схематичные изображения, созданные при помощи стандартных приложений (Visio).

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

Например: «1. Пользователь формирует документ

Пользователь инициирует процесс передачи документа на согласование
Система изменяет статус документа на «на согласовании». »
Основные технические решения

2.1. Решения по структуре системы и подсистем.

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

2.2. Средства и способы взаимодействия между компонентами системы. Взаимосвязь с внешними системами

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

Например: «В рамках взаимодействия КИП с внешними системами используются следующие технологии:
- «Бухгалтерия предприятия» - файловый обмен в установленном XML / Excel формате.»

2.3. Решения по режимам функционирования

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

2.4. Решения по численности, квалификации и функциям персонала АС

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

Например: «Администратор портала ответственный за:

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

2.5. Обеспечение заданных в техническом задании потребительских характеристик системы

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

Например: «Отказоустойчивость и работоспособность программных модулей КИП обеспечивается за счет применения промышленных программных платформ IBM WebSphere Portal, Enterprise Oracle 10g.»

2.6. Состав функций и комплекс задач, реализуемых системой

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

2.7. Решения по комплексу технических средств, его размещению на объекте

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

Требования к комплексу технических средств в пояснительной записке рекомендуется размещать в виде таблицы.
Например: «

Оборудование	Техническая характеристика
Сервер Базы данных
Исполнение для монтажа в стойку	Не более 4U
Архитектура процессоров	RISC (64-разрядная)
Частота процессора	не менее 1,5 ГГц
Кэш процессора	Не менее 1Мб
Операционные системы	Windows 2003 SP2
Возможное число устанавливаемых процессоров	Не менее 4
Число установленных процессоров
Объем возможной оперативной памяти	32 ГБ с ЕСС
Объем оперативной памяти	Минимум 8 ГБ
Наличие интерфейсов	10/100/1000 Base-T Ethernet интерфейсы 2 шт.; Ultra320 SCSI 2 шт.; USB 4 шт.; последовательный интерфейс 1 шт.; слоты расширения PCI 64-bit 6 шт.
Видео карта:	Не менее 8Мб.
Возможное число устанавливаемых жестких дисков	Не менее 4
Число установленных дисков
Устройство для считывания
Электрическое питание	Входные параметры: 200-240 В, частота тока: 50-60 Гц; максимальная входная мощность не более 1600 Вт; не менее 2х блоков питания обеспечивающих отказоустойчивость.

При описании размещения объектов комплекса технических средств в пояснительной записке необходимо руководствоваться требованиями СНиП 11-2-80 для зданий категории "В".

2.8. Объем, состав, способы организации, последовательность обработки информации

Информационное обеспечение включает в себя внутримашинное и внемашинное информационное обеспечение. В качестве внутримашинного информационного обеспечения выступают База данных (БД), входные и выходные документы, поступающие из внешних систем.

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

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

Например: «Входной информацией для подсистемы электронного документооборота является:

электронные версии документов производственного документооборота;
электронная цифровая подпись;

Выходной информацией для подсистемы электронного документооборота является:

журнал истории жизненного цикла документа;
журнал истории согласования документа;
файл электронной версии документа в формате RTF. »

2.9. Состав программных продуктов, языки деятельности, алгоритмы процедур и операций и методы их реализации

В данном разделе документа Пояснительная записка следует привести технологии и средства разработки системы.

Например:
«

Сервер базы данных: Oracle 10g
Портал: Websphere Portal Extend v6.0.
Бизнес-моделирование: ARIS

3 Мероприятия по подготовке объекта автоматизации к вводу системы в действие

В данном разделе документа Пояснительная записка описываются следующие мероприятия:

мероприятия по приведению информации к виду, пригодному для обработки на ЭВМ;
мероприятия по обучению и проверке квалификации персонала;
мероприятия по созданию необходимых подразделений и рабочих мест;
мероприятия по изменению объекта автоматизации;
другие мероприятия, исходящие из специфических особенностей создаваемых АС

Министерство экономического развития и торговли Российской Федерации

УТВЕРЖДАЮ

Государственный контракт № 000-05-07 от «29» октября 2007 г., заключенный между Министерством экономического развития и торговли Российской Федерации и ЗАО «ПРОГНОЗ», на выполнение работ по теме «Разработка автоматизированного модуля федерального мониторинга социально-экономического развития субъектов Российской Федерации в рамках создания единой информационной системы мониторинга ключевых показателей социально-экономического развития Российской Федерации и контроля результативности деятельности органов государственной власти по их достижению».

При разработке настоящего документа использовался Руководящий документ по стандартизации ГОСТ РД 50-34.698-90.

1. Общие положения.. 5

1.1. Полное наименование системы... 5

1.2. Документы, на основании которых ведется проектирование.. 5

1.3. Стадии и сроки исполнения.. 5

1.4. Цели и назначение.. 7

1.5. Соответствие проектных решений требованиям безопасности .. 8

1.6. Нормативно-технические документы... 9

2. Описание процесса деятельности.. 10

2.1. Перечень задач.. 10

2.2. Основные функции, выполняемые Модулем... 11

3. Основные технические решения.. 13

3.1. Структура Модуля, перечень подсистем... 13

3.1.1. Подсистема Централизованного хранилища данных. 14

3.1.2. Интерфейсная компонента. 15

3.1.3. Адаптерные программные компоненты. 16

3.6.3. Степень приспособляемости к отклонениям параметров объекта автоматизации. 26

3.6.4. Допустимые пределы модернизации и развития системы.. 26

3.6.5. Требования к надежности. 27

3.6.6. Требование безопасности. 27

3.6.7. Требования к эргономике и технической эстетике. 28

	Перечень работ	Ожидаемые результаты работ
	Разработка Централизованного хранилища данных (ЦХД) социально-экономической информации, используемой при осуществлении федерального мониторинга показателей социально-экономического развития (ПСЭР) субъектов Российской Федерации и муниципальных образований	Подсистема Централизованного хранилища данных
	Разработка схем данных ПСЭР и профилей технологических спецификаций, описывающих протоколы взаимодействия с интерфейсной компонентой и форматы публикуемых данных ПСЭР	Схемы данных ПСЭР и профили технологических спецификаций, описывающие протоколы взаимодействия с интерфейсной компонентой и форматы публикуемых данных ПСЭР; Отчет об обсуждении проектов спецификаций на схемы данных и профилей технологических спецификаций, с зафиксированными замечаниями и предложениями участников обсуждения.
	Разработка, апробация на пилотных объектах внедрения и доработка в соответствии с выявленными замечаниями, кроссплатформенного программного обеспечения интерфейсной компоненты	Интерфейсные компоненты
		Обязательная адаптерная компонента
	Разработка специфических адаптерных компонент, обеспечивающих автоматизированное получение информации о СЭР из унаследованных АИС источников данных и ее публикацию через интерфейсную компоненту в соответствии с ее спецификациями. Специфические адаптеры должны содержать блок верификации и проверки достоверности статистический информации	Специфические адаптерные компоненты; Регламент автоматического сбора информации, используемой при осуществлении федерального мониторинга и поставляемой с web-сайтов и из АИС федеральных министерств и ведомств, субъектов Российской Федерации, муниципальных образований в соответствии с разработанными спецификациями выходных параметров, предназначенных для предоставления информации этими источниками данных
	Разработка средств табличного, графического, картографического, текстового представления результатов мониторинга и анализа социально-экономического развития субъектов Российской Федерации.	Подсистема табличного, графического, картографического, текстового представления данных мониторинга и результатов анализа социально-экономического развития субъектов Российской Федерации
	Разработка подсистемы Модуля, предназначенной для расчёта критериев оценки развития секторов экономики субъектов федерации на основе информации, собираемой в процессе федерального мониторинга	Подсистема расчёта критериев оценки развития секторов экономики субъектов Российской Федерации (с возможностью выявления региональных кластеров) на основе информации, собираемой в процессе федерального мониторинга
	Разработка подсистемы Модуля, предназначенной для расчёта интегральных индексов и оценок социально-экономического развития субъектов федерации на основе информации, собираемой в процессе федерального мониторинга	Подсистема расчёта интегральных индексов и оценок социально-экономического развития субъектов Российской Федерации на основе информации, собираемой в процессе федерального мониторинга
	Разработка подсистемы Модуля, предназначенной для публикации информации о СЭР в соответствии с требованиями действующих нормативных актов и разработанных в рамках проекта, а также спецификациям на интерфейсную компоненту	Подсистема публикации в открытом доступе хранящейся в Модуле первичной и преобразованной информации о СЭР
	Разработка подсистемы администрирования	Подсистема администрирования
		Полный пакет проектной документации для Модуля федерального мониторинга в соответствии с требованием ГОСТ 34
	Проведения приемо-сдаточных испытаний, доработка Модуля в соответствии с замечаниями Заказчика

Пример «Пояснительная записка» (П2 по), разработанного для автоматизированной измерительно-информационной системы коммерческого учета электроэнергии (АИИС КУЭ) согласно к, и документа. по и. Редакция от 20.06.2018.

Пояснительная записка (П2 по ГОСТ 34.201-89) автоматизированной измерительно-информационной системы коммерческого учета электроэнергии (АИИС КУЭ) (пример)

Создан 25.03.2014 11:48:18

Внимание! Технические требования оптового рынка электроэнергии (ОРЭ), ссылки на пункты которых содержатся в примерах документов на автоматизированные измерительно-информационные системы коммерческого учета электроэнергии (АИИС КУЭ), меняются достаточно часто, но не нами, а администратором торговой системы (АТС). Просьба отнестись к этому с пониманием

Все документы боевые , прошедшие множество, включая экспертизы в ФГУП «Всероссийский научно-исследовательский институт стандартизации и сертификации в машиностроении» (ВНИИМАШ) РОССТАНДАРТА, поэтому сомнению не подлежит.

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

Сегодня мы поговорим об отечественных стандартах на проектную документацию. Как эти стандарты работают на практике, чем они плохи и чем хороши. При разработке документации для государственных и серьезных частных заказчиков у нас обычно нет выбора - в требования по документированию ТЗ вписано соблюдение стандартов. На практике мне приходилось сталкиваться с различными примерами недопонимания структуры стандартов, того, что должно быть в документах и зачем эти документы нужны. В итоге из-под пера техписателей, аналитиков и специалистов выходят порой такие перлы, что непонятно, в каком состоянии сознания они писались. А ведь на самом деле все достаточно просто. Поиск по Хабру не вернул ссылок на более-менее целостный материал на данную тему, потому предлагаю закрасить этот досадный пробел.

Что такое стандарты на документацию?

В серии 34, о которой идет речь, существует всего 3 основных стандарта по документированию:

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

Это базовый документ, в котором приводится полный перечень документации ГОСТ 34, рекомендации по кодированию документов, к каким стадиям проекта относятся документы (стадии описываются в ГОСТ 34.601-90), а также как их можно объединить между собой.

Фактически, этот стандарт представляет собой большую таблицу с комментариями. Ее можно загнать в Excel для удобства использования.

Объемистый стандарт, с различной степенью детальности описывающий содержание проектных документов. В качестве индекса используется упомянутый выше ГОСТ 34.201-89.

К стандарту РД 50-34.698-90 существует множество вопросов и трактовок его положений, которые ввиду их неконкретности, часто понимают по-разному заказчик и исполнитель или даже члены проектной команды. Но ничего более конкретного у нас, к сожалению, нет.

Рассмотрим теперь плюсы и минусы стандартов, начав традиционно с минусов.

Минусы стандартов

Основной минус всем очевиден - стандарты старые. В них заложено устаревшее представление об архитектуре автоматизированной системы. Например:

приложения двухуровневые, состоящие из клиентской программы и сервера СУБД (никаких трех- и более «уровневых» приложений, никаких Weblogic или JBoss)
структура таблиц базы данных, будучи описана, даст представление о логической модели данных (то, что между приложением и базой может находиться какой-нибудь Hibernate, тогда казалось нехорошим излишеством)
пользовательский интерфейс однооконный (а разве бывает другой? А что такое «браузер»?)
Отчетов в системе немного, все они бумажные и печатаются на матричном принтере
Разрабатываемая программа ориентирована на решение «задачи обработки информации», которая имеет четкий вход и выход и узко специализирована. В основе обработки информации лежит «алгоритм». Иногда «алгоритмов» бывает несколько. (Объектно-ориентированное программирование тогда делало лишь свои первые шаги и серьезно не рассматривалось).
администратор базы данных понимает, какая информация лежит в таблицах и активно участвует в редактировании системных справочников (а разве бывает один сервер СУБД для 50 разных приложений?)

Соответственно, в стандарте есть артефакты, наподобие следующего:

5.8. Чертеж формы документа (видеокадра)
В документе должно быть приведено изображение формы документа или видеокадра в соответствии с требованиями государственных стандартов унифицированной системы документации Р 50-77 и необходимые пояснения.

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

«Видеокадр» - это тоже документ, который выводился на текстовый дисплей. Дисплеи не всегда поддерживали нужные символы и нужное количество символов по горизонтали и строк по вертикали (а графику вообще не поддерживали). Поэтому тут тоже надо было дополнительно согласовывать формы всех экранных документов.

Сейчас уже нам ничего не говорят слова «машинограмма», «видеокадр», «АЦПУ». Я тоже их не застал в употреблении, хотя заканчивал профильный институт в 90-е. Это было время появления Windows 3.1, VGA дисплеев, трехдюймовых дискет и первых отечественных интернет-сайтов. Но в стандарте эти слова есть, и заказчик иногда капризно требует предоставить ему полный комплект документации в соответствии с ГОСТ 34.201-89. Более того, подобные формулировки в ТЗ кочуют из одного министерства в другое и стали уже неким негласным шаблоном, в который вбивают содержательную часть.

Так что документ с дурацким названием «Чертеж формы документа (видеокадра)» в проекте должен быть и должен быть не пустым.

Что в стандарте хорошо

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

А стандарты ГОСТ 34 хороши еще и тем, что они составлялись умными людьми, обкатывались годами и у них есть четкая цель - максимально полно описать на бумаге сложную абстрактную сущность, которую представляет собой любая АСУ.

Когда вам требуется грамотно поставить задачу западным подрядчикам, которые про наши ГОСТы слыхом не слыхивали, можно также опираться на эти стандарты, а точнее на их контент, смысловую составляющую. Потому что, повторюсь, гарантия полноты информации дорогого стоит. Как бы мы себя не тешили высоким уровнем своего профессионализма, мы можем забыть включить в состав наших требований элементарные вещи, тогда как тот же ГОСТ 34.602-89 «помнит» обо всем. Если вам непонятно, как должен выглядеть результат работы западных подрядчиков, посмотрите на требования к документированию, к рекомендуемым разделам. Уверяю вас, лучше не придумать! Скорее всего, есть западные аналоги наших стандартов, в которых все может быть полнее, современнее и лучше. К сожалению, я с ними не знаком, так как не было пока ни одного случая, чтобы наших ГОСТов было бы недостаточно.

Можно смеяться над тем, что создатели стандартов ничего не знали о java или.NET, о HD мониторах и Интернете, но я бы не советовал недооценивать масштаб проделанной ими работы и ее ценность для нашего профессионального сообщества.

Как читать и понимать стандарты документации по ГОСТ серии 34

Стандарт делит все документы по двум осям - время и предметная область. Если посмотреть таблицу 2 в ГОСТ 34.201-89, то хорошо видно это деление (колонки «Стадия создания» и «Часть проекта»

Стадии создания АСУ

Стадии создания определены в ГОСТ 34.601-90. Имеют отношение к документированию из них три:

Эскизный проект (ЭП)
Технический проект (ТП)
Разработка рабочей документации (РД)

Эскизный проект следует после стадии Техническое задание и служит для разработки предварительных проектных решений.

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

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

Части (разделы) проектной документации по созданию АСУ

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

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

Для того, чтобы полностью описать этот «автомат», сделаны следующие разрезы (как в черчении):

Математическое обеспечение (МО) , отвечающее на вопросы: какая логика зашита внутри «черного ящика»? Почему выбраны именно эти алгоритмы, именно такие формулы и именно такие коэффициенты?

Математическое обеспечение ничего не знает ни о процессорах, ни о базах данных. Это отдельная абстрактная область, обитель «сферических коней в вакууме». Но математическое обеспечение бывает очень плотно связано с предметной областью, aka Реальная жизнь. Например, управляющие алгоритмы для систем управления дорожным движением требуется согласовать в ГИБДД перед тем, как их будет согласовывать заказчик. И тут понимаешь, зачем их выделяют в отдельную книжицу. Потому что в ГИБДД никому не интересно, на какой ОС будет работать сервер приложения, а вот какой знак и ограничение скорости выскочит на табло в дождь или в снег очень даже интересно. Они отвечают за свою часть, и ничего другого подписывать не собираются. С другой стороны, когда они подписали, не будет вопросов к технической стороне вопроса - почему выбрали те, а не другие табло или светофоры. Мудрость «предков» как раз и проявляется в таких вот практических кейсах.

Информационное обеспечение (ИО) . Еще один срез системы. На этот раз делается прозрачным черный ящик нашей системы и мы смотрим на циркулирующую в нем информацию. Представьте себе модель кровеносной системы человека, когда все остальные органы невидимы. Вот что-то подобное и есть Информационное обеспечение. В нем описываются состав и маршруты прохождения информации внутри и снаружи, логическая организация информации в системе, описание справочников и систем кодирования (кто делал программы для производства, тот знает, как они важны). Основная описательная часть приходится на этап ТП, но в этап РД перетекают некоторые «рудименты», наподобие документа «Каталог баз данных». Понятно, что раньше он содержал именно то, что написано в названии. Но сегодня попробуйте для сложной комплексной системы сформировать такой документ, когда очень часто в составе системы используются покупные подсистемы со своими загадочными информационными хранилищами. Я уж не говорю о том, что этот документ не особенно сейчас и нужен.

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

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

Программное обеспечение (ПО) . Любимая всеми часть проектной документации. Да хотя бы потому, что это всего один документ! И потом, всем понятно, что туда нужно записывать. Но я, все-же, повторю.

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

Техническое обеспечение (ТО) . Не менее любимая всеми часть проектной документации. Радужную картину омрачает только обилие документов, которые требуется разрабатывать. Всего по стандарту требуется разработать 22 документа, из них 9 на стадии ТП.

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

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

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

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

На стадии РД появляются другие, более интересные документы, которые мне бы хотелось рассмотреть отдельно.

Руководство пользователя . Комментарии излишни, я думаю.

Методика (технология) автоматизированного проектирования . В этот документ при необходимости можно поместить описание процесса сборки ПО, управления версиями, тестирования и т.п. Но это если в ТЗ заказчик желает самолично осуществлять сборку ПО. Если он этого не требует (и не платит за это), то вся ваша внутренняя кухня не его ума дело, и этот документ делать не нужно.

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

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

Технологическая инструкция является прослойкой между ОРД и руководством пользователя. РП подробно описывает как нужно делать те или иные действия в системе. Технологическая инструкция говорит о том, какие действия необходимо выполнять в тех или иных случаях, связанных с эксплуатацией системы. Грубо говоря, технологическая инструкция это краткий дайджест по РП для конкретной должности или роли. Если у заказчика роли не сформированы или он хочет, чтобы вы сами сформировали роли и требования к должностям, включите в документ самые базовые роли, например: оператор, старший оператор, администратор. Замечания заказчика на тему, «а у нас не так» или «а нам не нравится» должны сопровождаться перечнем ролей и описанием должностных обязанностей. Потому что бизнес-процессы мы не ставим . Мы эти бизнес-процессы автоматизируем .

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

Описание технологического процесса обработки данных (включая телеобработку) . Жалкий рудимент пещерного века, когда были специально выделенные «Операторы ЭВМ», скармливающие машине перфокарты и упаковывающие распечатку результата в конвертик. Эта инструкция - для них. Что в нее писать в XXI веке - я вам точно сказать не могу. Выкручивайтесь сами. Самое лучшее, это просто забыть про этот документ.

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

А в-третьих, в состав ОР входит мега-документ под названием «Пояснительная записка к техническому проекту», который по задумке представляет собой некий Executive Summary, а по факту многие проектанты пихают в него вообще все полезное содержание стадии ТП. Подобный радикальный подход бывает оправдан и даже взаимно выгоден и заказчику и исполнителю работ, но в определенных случаях.

Варианты использования ГОСТ 34

Полное и точное следование стандарту . Добровольно никто, естественно, такую тучу документов писать не будет. Поэтому полный комплект документов готовится только по настоятельной просьбе заказчика, которую он закрепил в ТЗ и еще договором сверху придавил. В таком случае требуется понимать все буквально и отдать заказчику физические «книжки», на которых будут стоять названия документов из таблицы 2 ГОСТ 34.201-89 за исключением совсем уж ненужных, перечень которых вы обязательно должны обговорить и закрепить письменно. Содержание документов также должно без всякой фантазии соответствовать РД 50-34.698-90, вплоть до названия разделов. Для того, чтобы у заказчика взорвался мозг, иногда большую систему делят на подсистемы, и для каждой подсистемы выпускают отдельную проектную документацию. Выглядит это устрашающе и нормальному контролю при помощи земного разума не подлежит. Особенно в части интеграции подсистем. Что значительно упрощает приемку. Главное, чтобы вы сами при этом не запутались и чтобы ваша система все-таки заработала как надо.
Мы просто любим ГОСТы . В серьезных больших компаниях любят стандарты. Потому, что они помогают людям лучше понимать друг друга. Если ваш заказчик замечен в любви к порядку и стандартизации, постарайтесь придерживаться стандартной идеологии ГОСТ при разработке документов, даже если этого не требует ТЗ. Вас лучше поймут и одобрят согласующие специалисты, а вы сами не забудете включить в документацию важную информацию, лучше будете видеть целевую структуру документов, точнее планировать работы по их написанию и сэкономите себе и коллегам массу нервов и денег.
Нам плевать на документацию, лишь бы все работало . Исчезающий вид безответственного заказчика. Подобный взгляд на документацию пока еще можно встретить у небольших и бедных заказчиков, а также в оставшихся со времен перестройки авторитарных «идиотократиях», где босс окружен верными друзьями - директорами, и все вопросы решаются в личных беседах. Вы вольны в подобных условиях забивать на документирование вообще, но лучше, все таки, прицел не сбивать и хотя бы схематично наполнять содержимым документацию. Если не этому заказчику, так следующему передадите (продадите).

Заключение

Эта статья была о наших ГОСТах на документирование АСУ. ГОСТы старые, но, как оказалось, до сих пор очень даже полезные в хозяйстве. Не считая некоторые явные рудименты, структура документации обладает свойствами полноты и непротиворечивости, а следование стандарту снимает многие проектные риски, о существовании которых мы можем по началу не догадываться.

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

Ниже представлен пример (образец) проектного документа "Пояснительная записка к техническому проекту на создание автоматизированной системы ", основанный на методических указаниях РД 50-34.698-90 . Данный документ формируется IT-специалистом на стадии технического проектирования информационной системы .

В качестве примера разработки информационной системы использован проект внедрения информационно-аналитической системы «Корпоративное хранилище данных» .

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

Разделы пояснительной записки:

Общие положения

Основные технические решения