Комплекс отраслевых руководящих методических материалов на информационные системы на железнодорожном транспорте ОРММ ИСЖТ 2.01-00 "Требования к составу, содержанию и оформлению документов при создании информационных систем" (утв. Министерством путей сообщения РФ 28 ноября 2000 г.) (не применяется)

Комплекс отраслевых руководящих методических материалов на информационные системы на железнодорожном транспорте ОРММ ИСЖТ 2.01-00
"Требования к составу, содержанию и оформлению документов при создании информационных систем"
(утв. Министерством путей сообщения РФ 28 ноября 2000 г.)

ГАРАНТ:

Приказом Минтранса России от 26 августа 2019 г. N 285 настоящий документ признан не подлежащим применению с 26 августа 2019 г.

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

1.1 Отраслевой руководящий методический материал "Требования к составу и содержанию документов при создании информационных систем (ОРММ ИСЖТ 2.01-00)" предназначен для уточнения применительно к отрасли железнодорожного транспорта требований Комплекса стандартов и руководящих документов на автоматизированные системы (КС АС), Единой системы программной документации (ЕСПД), Единой системы конструкторской документации (ЕСКД), а также отдельных международных и национальных стандартов.

1.2 Данный ОРММ ИСЖТ 2.01-00 распространяется на все виды автоматизированных систем, разрабатываемых на железнодорожном транспорте: автоматизированные системы управления технологическими процессами (АСУТП), предприятиями (АСУП), системы автоматизированного проектирования (САПР), информационно-справочные (ИСС), системы сбора и передачи информации (ССПИ), интегрированные автоматизированные системы (ИАС) и др. Укрупненная система классификации видов АС, используемых в отрасли, и их компонентов, приведена в разделе 2.

1.3 Документация на все виды АС должна разрабатываться в соответствии с ГОСТ 34.201-89 и рекомендациями международных стандартов и данного документа. В зависимости от вида АС и применяемых методов проектирования, а также специфики создаваемых АС допускается расширять номенклатуру документов, установленную ГОСТ 34.201. В настоящем ОРММ ИСЖТ 2.01-00 приведен перечень документов (таблица 4), необходимость разработки которых при проектировании различного вида систем определяется классом системы, ее архитектурой и требованиями Заказчика.

1.4 Состав документов по стадиям разработки устанавливается договором на создание научно-технической продукции и Техническим заданием (ТЗ).

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

1.5 Содержание каждого разрабатываемого документа определяет разработчик в зависимости от объекта проектирования (системы, автоматизированного рабочего места и пр.) с учетом РД 50-34.698 и данного ОРММ ИСЖТ 2.01-00.

2 Классификация АС, функционирующих на железнодорожном транспорте

Автоматизированная система (АС) - система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций (ГОСТ 34.003).

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

В таблице 1 приведена укрупненная классификация (с точки зрения документирования) автоматизированных систем и их основных компонентов, функционирующих на железнодорожном транспорте. Определение каждого класса системы дано в разработанном ранее ОРММ АСЖТ 0.01-96 (приложение Б).

ГАРАНТ:

По-видимому, в тексте предыдущего абзаца допущена опечатка. Имеется в виду "приложение 2"

Таблица 1 - Укрупненная классификация АС на ЖТ

Наименование класса системы	Примеры
Автоматизированные системы управления
1 Комплексные многоуровневые системы	АСУ-дороги, АС-Ш, АСУПХ и пр.
2 Системы управления предприятиями (АСУП)	АСУ-ДЕПО, АСУ-ВРЗ и пр.
3 Информационно-управляющие организационно-производственными процессами (ИУС)	АСУ СС, АСУ ГС, АСУ КП, КСАРМ сортировочной станции, КСАРМ контейнерной площадки и пр.
4 Автоматизированные системы управления технологическими процессами (АСУТП)	УВТК ДЦ, КГМ, ЛИУК, микропроцессорные ДЦ и пр.
Другие автоматизированные системы
5 Интегрированные автоматизированные системы (ИАС)	АСОУП, ИОММ, "Экспресс-2" и пр.
6 Информационно-справочные системы (ИСС)	ДИСКОР, АСНТИ и пр.
7 Автоматизированные системы обработки данных (АСОД)	ИОДВ, автоматизированные системы бухгалтерского учета, статистической отчетности и пр.
8 Системы автоматизированного проектирования (САПР)	КСАП и пр.
9 Автоматизированные системы диагностики технических и программных средств	Автоматизированные системы контроля диагностики уширения колес; системы измерения пути и пр.
Компоненты автоматизированных систем
10 Автоматизированное рабочее место (АРМ) в АС	АРМ ТВК, АРМ оператора техконторы, АРМ оператора транзитного потока файлов и пр.
11 Автоматизированное рабочее место (автономное)	АРМ экономиста, АРМ юриста и пр.
12 Аппаратно-программный комплекс (АПК)	Интеллектуальные модемы, узлы коммутации, мультиплексоры, контроллеры, драйверы, специализированного ввода информации и пр.
13 Системы сбора и передачи информации (ССПИ)	ЕСПД, ДИСКЛ, ДИСКЕ, системы автоматического считывания, концентраторы информации и пр.
14 Общесистемное программное обеспечение АС	Системы обработки файлов, системы передачи данных, программное обеспечение локальной сети и пр.
15а Информационная база (банк) данных в АС (статическая)	Электронная картотека технических паспортов грузовых вагонов и пр.
15б Информационная база данных в АС (динамическая)	Модели перевозочного процесса (поездная модель, вагонная модель, отправочная модель, контейнерная модель и пр.)
16 Комплекс задач (задача)	АИЛ, КОО-4 и пр.

3 Основные принципы разработки документации

3.1 Представленный в данном документе порядок документирования охватывает этапы жизненного цикла системы от формирования концепции до внедрения и сопровождения.

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

3.2 Стороны - участники проекта ответственны за выбор модели комплекта документации для конкретного проекта и за адаптацию приведенных в данном ОРММ документов. Стороны также ответственны за выбор и применение методов и инструментальных средств автоматизации разработки программного обеспечения.

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

3.4 Порядок разработки и комплектования документации

3.4.1 Документация разрабатывается как на АС в целом, так и на отдельные функциональные части (задачи) и компоненты. Наименование конкретных документов на АС в целом или ее части (комплекс задач, автоматизированное рабочее место, задачу и пр.) определено ГОСТ 34.201, на комплексы программ (программы) - ГОСТ 19.101.

3.4.2 В зависимости от специфики создаваемых АС и применяемых методов проектирования допускается разрабатывать групповые и базовые документы, выпускать документы отдельными самостоятельными частями, расширять номенклатуру документов, установленную стандартами и данным ОРММ ИСЖТ.

3.4.3 Компоненты АС могут быть частью системы или иметь самостоятельное применение. Документация для компонентов АС разрабатывается в соответствии с приведенными в таблице 2 системами Государственных стандартов.

Таблица 2 - Используемые системы ГОСТ для разработки компонентов системы

Наименование компонентов	Система ГОСТ
Программные средства и программные изделия	ЕСПД
Информационные средства и информационные изделия	КС АС, ЕСКД
Программно-технические комплексы	КС АС, ЕСПД
Автоматизированные рабочие места в АС	КС АС, ЕСПД
Автоматизированные рабочие места автономные	ЕСПД
Аппаратно-программные комплексы	ЕСКД, ЕСПД, КС АС
Банки данных и базы данных в АС	КС АС, ЕСПД
Технические средства в АС	ЕСКД, КС АС, ЕСПД

3.4.4 Допускается выпуск проектной документации в соответствии с международными и национальными стандартами (в том числе ГОСТ Р ИСО/МЭК ТО 9294-93, ИСО 6592:1986 и др.), в первую очередь, при разработке систем с помощью закупленных CASE-средств, что должно быть указано в техническом задании.

3.4.5 В случае применения закупленных CASE-средств в техническом задании на систему при описании методологии, технологии и инструментального средства проектирования (CASE-средств) устанавливают требования к оформлению документации:

- комплектность, состав и структура на каждой стадии проектирования;

- требования к оформлению (включая требования к разделам документов) или ссылки на нормативные документы;

- требования к издательской системе, используемой в качестве встроенного средства подготовки документации;

- требования к настройке CASE-средств для обеспечения подготовки документации в соответствии с установленными правилами.

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

3.4.6 Общий перечень документов, который используется при проектировании системы в целом и ее частей, приведен в таблице 3. Документация на АС, ее части и компоненты подразделяется на:

- документацию процесса разработки, включающую подробные технические описания и подготавливаемую для специалистов, ведущих проектирование, разработку и сопровождение информационных систем, обеспечивающую возможность отчуждения, детального освоения, развития и корректировки ими программ, баз данных и технологических процессов на всем жизненном цикле системы;

- эксплуатационную документацию (ЭД) - документацию продукции, создаваемую для конечных пользователей системы и позволяющую им осваивать и эксплуатировать ее для решения конкретных функциональных задач.

3.4.7 Документация разработки АС и ее частей содержит согласно ГОСТ 34.201 следующие части проекта (таблица 3):

- общесистемные решения (ОР);

- решения по организационному обеспечению (ОО);

- решения по техническому обеспечению (ТО);

- решения по информационному обеспечению (ИО);

- решения по программному обеспечению (ПО);

- решения по математическому обеспечению (МО).

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

3.4.8 Эксплуатационная документация (ЭД), отмеченная в таблице 3 знаком "Х", включает документы, предназначенные для:

- пользователей, которые эксплуатируют АС и ее компоненты;

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

Таблица 3 - Перечень документов, который используется при проектировании системы в целом и ее частей

Часть проекта	Стадия	Наименование документа	ЭД	Код документа	Раздел с описанием содержания
Общесис-темные решения (ОР)	ЭП	Ведомость эскизного проекта		ЭП	5.2.1
		Пояснительная записка к эскизному проекту		П1	5.2.3
	П-П	Ведомость пилот-проекта		П-П	5.2.1
		Пояснительная записка к пилот-проекту		П-П2	5.2.3
	ТП	Ведомость технического проекта		ТП	5.2.1
		Ведомость покупных изделий		ВП	ГОСТ 2.106
		Пояснительная записка к техническому проекту		П2	5.2.3
		Описание информационной технологии системы		ПТ	5.2.2
		Описание автоматизируемых функций		П3	5.2.4
		Описание постановки задачи (комплекса задач)		П4	5.2.5
		Описание постановки общесистемного проектного решения по базе данных		П12	5.2.10
	ТП, РД
		Ведомость технорабочего проекта		ТРП	5.2.1
	РД	Ведомость держателей подлинников		ДП	ГОСТ 2.112
		Ведомость рабочей документации		РД	5.2.1
		Общее описание системы		ПД
		Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистем, систем)		ПМ	5.2.9
		Паспорт	хх	ПС	5.2.7
Решения по организа-ционному обеспечению (ОО)	ТП	Описание организационной структуры		ПВ	5.3.1
	РД	Методика (технология) автоматизированного проектирования	хх	И1	Для САПР 5.3.2
		Технологическая инструкция	хх	И2	5.3.3
		Руководство пользователя	хх	И3	5.3.4
		Описание технологического процесса обработки данных (включая телеобработку)	хх	ПГ	5.3.5
		Руководство администратора БД	хх	И5	5.3.7
		Руководство администратора системы	хх	И6	5.3.6
Решения по информа-ционному обеспечению (ИО)	ТП	Перечень входных сигналов и данных		В1	5.5.1
		Перечень выходных сигналов (документов)		В2	5.5.2
		Описание информационного обеспечения системы		П5	5.5.3
		Описание организации информационной базы		П6	5.5.5
		Описание систем классификации и кодирования		П7	5.5.3
		Чертеж формы документа (видео-кадра)	хх	С9	5.5.7
		Описание регулярных запросов к базе данных		П11	5.5.11
	РД	Каталог базы данных	хх	В7	5.5.8
		Состав выходных данных (документов, сообщений)	хх	В8	5.5.4
		Инструкция по формированию и ведению базы данных (набора данных)	хх	И4	5.5.10
Решения по программному обеспечению (ПО)	ТП	Описание программного обеспечения		ПА	5.6.1
		Техническое задание на программное средство		ТЗ	5.9.2
		Пояснительная записка		81	-"-
	РД	Спецификация			5.9.9
		Текст программы		12	5.9.8
		Описание комплекса программ (программы)		13	5.9.4
		Описание применения	хх	31	5.9.3
		Руководство системного программиста	хх	32	5.9.6
		Руководство программиста		33	5.9.5
		Руководство оператора	хх	34	5.9.7
		Руководство оперативного пользователя	хх	91	5.9.11 (разраб.для Mainframe)
		Руководство по инсталляции	хх	И7	5.9.12
		Руководство по организации сопровождения	хх	92	ОРММ 5.02-00 (приложение А)
		Программа и методика испытаний		51	ГОСТ 19.301 (для ПС)
Решения по математи-ческому обеспечению (МО)	ТП	Описание алгоритма (проектной процедуры)		ПБ	5.7.1
Решения по техническому обеспечению (ТО)	ТП	Описание комплекса технических средств		П9	5.4.1
	РД	Описание локальной вычислительной сети	хх	П10	5.8.1
		Инструкция по эксплуатации КТС	хх	ИЭ	5.4.2
		Схема соединения внешних проводок		С4	5.4.3
		Схема подключения внешних проводок		С5	5.4.4
		Таблица соединений и подключений		С6	РД 50-34.698 (п. 4.12)
		План расположения оборудования и проводок		С7	РД 50-34.698 (п. 4.4)
Примечание - Другие возможные документы, которые могут быть необходимы при разработке систем, приведены в ГОСТ 34.201 (таблица 2).

3.5 Состав документации на АС и ее части

3.5.1 Документация на АС состоит из документов, приведенных в ГОСТ 34.201 и разработанных в данном ОРММ ИСЖТ на основе опыта создания информационных систем и рекомендаций международных стандартов. Набор документов для конкретной АС зависит от класса АС, вида продукции, требований заказчика, инструментальных средств разработки, состава компонентов, имеющих самостоятельное применение, условий эксплуатации, сопровождения и др.

В таблице 4 данного документа приведен рекомендуемый состав документов на АС и их компоненты в зависимости от класса системы, необходимости тиражирования на другие объекты (признак типовости) и используемых при эксплуатации ЭВМ.

3.5.2 Основными документами при разработке системы в целом на стадии ТП являются:

- Ведомость технического проекта (код - ТП).

- Пояснительная записка к техническому проекту (код П2).

- Описание информационной технологии системы (для комплексных многоуровневых и интегрированных систем) - (код - ПТ).

- Описание автоматизируемых функций (код - П3).

- Описание информационного обеспечения системы (код - П5).

- Описание комплекса технических средств (код - П9).

- Описание программного обеспечения (код - ПА).

- Описание организационной структуры (код - ПВ).

3.5.3 Основными документами на систему в целом на стадии РД являются:

- Описание технологического процесса обработки данных, включая телеобработку (код - ПГ).

- Общее описание системы ( код - ПД).

- Руководство пользователя (код - И3).

- Руководство администратора системы (код - И6) - разрабатывается при необходимости.

- Описание комплекса программ (код - 13).

- Спецификация (по ЕСПД).

- Паспорт (ПС).

- Ведомость эксплуатационной документации (ЭД).

- Ведомость рабочей документации (РД).

Документация на комплекс задач (задачу) включает отдельные документы из перечня, приведенного в таблице 4 данного документа.

Набор документов зависит от:

- состава документации на всю АС;

- наличия ТЗ на комплекс задач (АРМ, задачу);

- требований заказчика; инструментальных средств разработки;

- условий эксплуатации и сопровождения.

3.5.4 Основными документами для комплекса задач (задачи) и АРМ, входящих в систему, на стадии ТП являются:

- Ведомость технического проекта (код - ТП).

- Описание информационной технологии комплекса задач (код - ПТ) - разрабатывается для крупных комплексов.

- Описание постановки комплекса задач (задачи) (код - П4) - разрабатывается для небольших комплексов и АРМов.

3.5.5 Основными документами для комплекса задач (задачи) и АРМ, входящих в систему, на стадии РД являются:

- Ведомость рабочего проекта.

- Описание технологического процесса обработки данных (код - ПГ) - требуется при распределенной обработке данных.

- Руководство пользователя (код - И3).

- Технологические инструкции (код - И2) - при необходимости.

- Описание комплекса программ (код - 13) - документ сопровождения.

- Текст программ (код - 12) - документ сопровождения.

- Спецификация (по ЕСПД).

- Паспорт (ПС).

- Ведомость эксплуатационной документации (ЭД).

3.5.6 Для комплексов задач (задачи), входящих в систему и разработанных на базе Mainframe, основными документами на стадии ТП являются:

- Ведомость технического проекта.

- Описание постановки задачи (код - П4) - для небольших комплексов.

- Описание информационной технологии системы (код - ПТ) - для крупных комплексов.

3.5.7 Для комплексов задач (задачи), входящих в систему и разработанных на базе Mainframe, основными документами на стадии РД являются:

- Ведомость рабочей документации (код - РД).

- Описание технологического процесса обработки данных (код - ПГ) - требуется при распределенной обработке данных.

- Описание комплекса программ (код - 13) - документ сопровождения.

- Руководство системного программиста (код - 32).

- Руководство оператора ( код - 34)

- Текст программы (код - 12) - документ сопровождения.

- Спецификация (по ЕСПД).

- Паспорт (код - ПС).

- Ведомость эксплуатационных документов (код - 20).

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

"Руководство системного программиста", "Руководство оператора" (или объединенный документ "Руководство оперативного пользователя") для комплекса задач могут не разрабатываться, если вся информация включена в документы по запуску системы в целом.

3.5.8 Для автономных АРМ основными документами являются:

Техническое задание (код - ТЗ).

Описание применения (код - 31).

Руководство пользователя (код - П4).

Описание комплекса программ (код - 13) - документ сопровождения

Спецификация (по ЕСПД).

Паспорт (код - ПС).

Ведомость эксплуатационной документации (код - 20).

В ряде случаев при разработке несложных АРМ документы "Описание применения" и "Руководство пользователя" могут быть объединены.

3.6 Рекомендуемый состав документов на систему и ее компоненты в зависимости от класса системы и используемых ЭВМ

Таблица 4

Стадии создания	Наименование документа	Код документа и признак экспл. док.	Содержание (ГОСТ, РД и другие нормативные документы)	Класс АС в соответствии с таблицей 1 данного документа	АС и ее части на базе				Примечание
					Mainframe + ПЭВМ		ПЭВМ
					типовая	нетиповая	типовая	нетиповая
ЭП	Ведомость эскизного проекта	ЭП	ГОСТ 2.106	1-5	+	0	+	0
	Пояснительная записка к эскизному проекту	П1	РД 50-34.698	1-5	+	0	+	0
Пилот-проект	Ведомость пилот-проекта	П-П	ГОСТ 2.106	2-5	+	+	+	+
	Пояснительная записка к пилот-проекту	П-П2	РД 50-34.698 и настоящий документ	2-13	+	+	+	+	При необходимости включает отдельные разделы документов ТП
ТП	Ведомость технического проекта	ТП	ГОСТ 2.106	2-13, 15-16	экс	+	+	+
ТП	Пояснительная записка к техническому проекту	П2	РД 50-34.698	2-13, 15-16	+	0	+	0	Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию
	Описание информационной технологии системы	ПТ	Настоящий документ	1-5	+	+	0	0
	Описание автоматизируемых функций	П3	РД 50-34.698	2-8	0	0	0	0	Разрабатывается для системы в целом
	Описание постановки общесистемного проектного решения по базе данных	П12	Настоящий документ	2-7, 10, 11, 13, 15	0	0	0	0	Разрабатывается для системы в целом и частного ТЗ на БД
ТП	Описание постановки задачи (комплекса задач)	П4	РД 50-34.698 и настоящий документ	10-11, 16	+	+	+	+	Для подсистем (комплексов задач, задачи, АРМ)
	Описание информацион-ного обеспечения	П5	РД 50-34.698	2-10, 15	+	+	+	+
	Описание системы классификации и кодирования	П7	РД 50-34.698	2-11, 15	+	0	+	0	Для несложных АС и отдельных задач может включаться в документ П5
ТП	Перечень входных сигналов и данных	В1	РД 50-34.698	1-10, 12-13	0	0	0	0
	Перечень выходных сигналов (документов)	В2	РД 50-34.698		0	0	0	0
	Описание комплекса технических средств	П9	РД 50-34.698	2-10	+	0	0	0
	Описание программного обеспечения	ПА	РД 50-34.698	2-9, 12-15	+	0	0	0
	Описание алгоритма (проектной процедуры)	ПБ	РД 50-34.698	10-11, 16	+	+	+	+	Допускается включать в П2, П4
	Описание организацион-ной структуры	ПВ	РД 50-34.698	1-7, 10-11	0	0	0	0	Разрабатывается для системы в целом
ТП, РД	Чертеж формы документа (видео-кадра)	С9+	УСД, Р50-77	2-13, 16	0	0	0	0
	Ведомость технорабочего проекта	ТРП	ГОСТ 2.106	1-16	+	+	+	+
	Описание локальной вычислительной сети ПЭВМ	П10	Настоящий документ	2-3, 5-6	0	0	0	0	Разрабаты-вается для АСУП, КСАРМ
РД	Ведомость рабочей документации	РД+	ГОСТ 2.106	2-16	+	0	+	0
	Каталог базы данных	В7+	РД 50-34.698	1-7, 10-11, 15-16	0	0	0	0	Для небольших БД включается в И3
РД	Методика (технология) автоматизированного проектирования	И1	РД 50-34.698	8	+	+	+	+	Для САПР
	Состав выходных данных (сообщений)	В8	РД 50-34.698	2-10	0	0	0	0	Для АРМ и несложных АС может включаться в документ П5
РД	Руководство пользователя	И3+	РД 50-34.698 и настоящий документ	2-16	+	+	+	+
	Инструкция по формированию и ведению базы данных (набора данных)	И4+	РД 50-34.698	2-11, 15	+	+	+	+	Для АС, имеющих отн. небольшую БД, может оформляться как раздел И3
	Руководство администратора БД	И5+	Данный документ	15	+	+	+	+
РД	Руководство администратора системы	И6+	Данный документ	1-9	0	0	0	0
	Инструкция по эксплуатации КТС*	ИЭ+	РД 50-34.698	9, 12	+	0	+	0
	Описание технологического процесса обработки данных, включая телеобработку	ПГ+	РД 50-34.698	1-7, 10-11, 15-16	+	0	+	0
	Общее описание системы	ПД	РД 50-34.698	1-9, 12-13	0	0	0	0
РД	Описание регулярных запросов к БД	ПЗ	Настоящий документ	1-11, 15	0	0	0	0
	Схема соединений внешних проводок	С4+	РД 50-34.698	2-5, 12-13	0	0	0	0	Оформляется в виде таблицы
РД	Схема подключения внешних проводок	С5+	РД 50-34.698	2-5, 12-13	0	0	0	0	Оформляет-ся в виде таблицы
	Таблица соединений и подключений	С6+	РД 50-34.698	2-5, 12-13	0	0	0	0	Оформляет-ся в виде таблицы
	Программа и методика испытаний (компонентов, средств автоматизации, подсистем, систем)	ПМ	РД 50-34.698 и настоящий документ	1-16	+	0	+	0	Для типовых систем и компонентов дорожного и линейного уровня
	Ведомость держателей подлинников	ДП	ГОСТ 2.112	2-16	0	0	0	0-
	Паспорт	ПС+	РД 50-34.698 и настоящий документ	1-16	+	+	+	+
Все стадии	Таблицы	ТБ	-	1-16	0	0	0	0
	Расчеты	РР	-	1-16	0	0	0	0
	Документы	Д	-	1-16	0	0	0	0
		Программная документация
	Техническое задание на программное средство	-	ГОСТ 19.208	11, 14-16	0	0	0	0
ТП	Пояснительная записка	81	ГОСТ 19.404	11, 14-16	+	0	+	0	Обязателен при отсутствии ТП на систему
РД	Спецификация	-	ГОСТ 19.202	2-16	+	0	+	0	Для программных средств
	Текст программы	12	ГОСТ 19.401	2-16	0	0	0	0
	Описание программы (комплекса программ)	13	ГОСТ 19.402-78*	2-16	+	0	+	0
РД	Описание применения	31	ГОСТ 19.502-78* и настоящий документ	11, 14-16	0	0	0	0	Обязателен при отсутствии ТП
	Руководство системного программиста	32+	ГОСТ 19.503-79*	2-10, 14-16	+	0	-	-	Может объединяться с другими документами
	Руководство программиста	33+	ГОСТ 19.504-79* и настоящий документ	2-10, 14-16	+	0	-	-	- " -
	Руководство по инсталляции	И7+	Настоящий документ	1-7, 10-11	0	0	0	0
	Руководство оператора	34+	ГОСТ 19.505-79* и настоящий документ	2--10, 14-16	+	+	-	-	- " -
	Программа и методика испытаний	51	ГОСТ 19.301-79*	14-16	0	0	0	0
РД	Руководство по организации сопровождения	92	ОРММ ИСЖТ	1-16	0	0	0	0
	Руководство оперативного пользователя	91+	Настоящий документ	1-16	0	0	-	-	Объединяет 32, 33, 34, 35
Примечания 1 В таблице 4 приняты следующие обозначения: ЭП - эскизный проект. ТП - технический проект. РД - рабочая документация. 2 Знак "+" в графах 6-9 означает обязательность разработки документа. Знак "-" - разработка документа необязательна, Знак "0" - необходимость разработки документа и включения его в комплект устанавливается в техническом задании на создание АС и ее компонентов. 3 В системах с большими объемами ввода данных может быть разработано "Руководство оператора". 4 Типовыми разработками являются те, для которых предусмотрено широкое тиражирование на другие объекты.

3.7 Состав документации на программные средства

3.7.1 Отдельные программные средства, имеющие самостоятельное применение (расчетные, оптимизационные и др.), как правило, оформляются в соответствии с ЕСПД.

3.7.2 Основными документами для типовых программных средств и программных изделий, имеющих самостоятельное применение, являются:

Техническое задание	ГОСТ 19.201
Пояснительная записка (на стадии ТП)	ГОСТ 19.404
Спецификация	ГОСТ 19.202
Описание комплекса программ	ГОСТ 19.402
Описание применения (разрабатывается при отсутствии ТП)	ГОСТ 19.502
Руководство оперативного пользователя	ГОСТ 19.503, ГОСТ 19.504, ГОСТ 19.505
Паспорт	Данный ОРММ

3.7.3 Состав программных документов для программных средств в составе АС:

- Техническое задание.

- Спецификация.

- Описание применения (при отсутствии ТП).

- Описание комплекса программ.

- "Руководство оперативного пользователя" (по ЕСПД) или

"Руководство пользователя" (по КС АС).

- Паспорт ПС (для ПС, имеющих самостоятельное применение вне системы).

3.8 Состав документов при проектировании базы данных

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

В обоих случаях состав и содержание технического проекта соответствует в целом ГОСТ 34.201 и РД 50-34.698.

3.8.2 Для описания проектных решений по базе данных на стадии ТП разрабатываются следующие документы:

- Пояснительная записка к техническому проекту.

- Описание программного обеспечения по созданию и ведению БД.

- Описание организации информационной базы.

- Описание постановки общесистемного проектного решения по БД.

- Описание регулярных запросов к БД.

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

3.8.3 На стадии "рабочая документация" состав и содержание проекта соответствует в целом ГОСТ 34.201, РД 50-34.698, 19.101, 19.202, 19.401, 19.402, 19.502, 19.503.

3.8.4 Документы по проектируемой БД на стадии "рабочая документация":

- Инструкция по формированию и ведению базы данных.

- Руководство администратора БД (описание технологического процесса).

- Каталог базы данных.

- Ведомость документов технорабочего проекта.

- Паспорт.

3.9 Документация по комплексу технических средств для ИС

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

- Схема автоматизации.

- Описание комплекса технических средств.

- План расположения.

- План расположения оборудования и проводок.

- Технические задания на разработку специализированных (новых) технических средств.

- Перечень заданий на разработку специализированных (новых) технических средств.

- Схема структурная комплекса технических средств.

- Схема соединения внешних проводок.

- Схема подключения внешних проводок.

- Таблица соединений и подключений.

- Схема деления системы (структурная).

- Чертеж общего вида.

- Чертеж установки технических средств.

- Схема принципиальная.

- Спецификация оборудования.

- Инструкция по эксплуатации КТС.

3.9.1 Перечень необходимых для проектирования системы документов по техническим средствам и другому оборудованию определяется в ТЗ и (или) договоре

3.9.2 Состав и содержание документов по комплексу технических средств для ИС определяется ГОСТ 34.201 и РД 50-34.698, для задачи - ГОСТ 19.508 (ЕСПД). Виды документов на разрабатываемые технические средства для ИС и их частей - по ГОСТ 2.102, в части эксплуатационных документов - по ГОСТ 2.601.

4 Обозначение документов

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

Все заимствованные документы сохраняют ранее присвоенные коды.

4.2 Обозначение документа имеет следующую структуру:

                    ХХХХХХХХ    ХХХХХ.    ХХХ.     ХХ.   ХХ.    Х -    Х.

                       |          |        |        |    |      |      |

Код организации-       |          |        |        |    |      |      |

разработчика-----------/          |        |        |    |      |      |

                                  |        |        |    |      |      |

Код классификационной             |        |        |    |      |      |

характеристики (подсистема,       |        |        |    |      |      |

комплекс) АС или ее части---------/        |        |    |      |      |

                                           |        |    |      |      |

Регистрационный номер АС-------------------/        |    |      |      |

или ее части                                        |    |      |      |

                                                    |    |      |      |

Код документа---------------------------------------/    |      |      |

                                                         |      |      |

Порядковый номер документа одного наименования-----------/      |      |

                                                                |      |

Номер редакции документа----------------------------------------/      |

                                                                       |

Номер части документа--------------------------------------------------/

4.3 Код организации-разработчика присваивают в соответствии с Общероссийским классификатором предприятий и организаций (ОКПО).

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

4.5 Регистрационный номер системы или ее части присваивают службы организации разработчика от 001 до 999 по каждому коду регистрационной характеристики.

4.6 Код документа присваивают в соответствии с таблицей 4 настоящего документа, а для остальных, не представленных в таблице 4 документов - по ГОСТ 34.201 или ГОСТ 19.103. Код документа отделяют от предыдущего обозначения точкой.

4.7 Порядковые номера документов одного наименования (два знака) присваивают, начиная со второго, и отделяют от предыдущего обозначения точкой.

4.8 Номер редакции документа присваивают, начиная со второй в порядке возрастания от 2 до 9, и отделяют от предыдущего значения точкой.

4.9 Номер части документа отделяют от предыдущего обозначения дефисом. Если документ состоит из одной части, то дефис не проставляют и номер части документа не присваивают.

4.10 В целях систематизации и информирования предприятий отрасли о новых системах и комплексах задач подразделения организаций-разработчиков, ответственные за присвоение обозначений документов, должны согласовывать коды классификационных характеристик систем с Отраслевым фондом алгоритмов и программ, который ведет БФ ВНИИАС МПС России.

Примеры:

1) Задача сетевого уровня, разработчик - ГВЦ МПС.

"Составление отчета об использовании грузоподъемности вагонов при погрузке грузов (ЦО-29)", "Описание постановки задачи": 04704353.18110.003. П4.

2) АРМ на ПЭВМ дорожного уровня, разработчик - БФ ВНИИАС:

"Автоматизированное рабочее место нарядчика локомотивных бригад" (АРМ ТЧБ), "Руководство пользователя:

01124388.48450.002. И3.

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

В - ведомость,

С - схема,

И - инструкция,

Б - основание,

П - описание,

второй знак - цифра или буква, указывающая порядковый номер документа данного вида.

Например, код документа "Описание локальной вычислительной сети для ПЭВМ" - П10.

5 Требования к содержанию документов

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

5.1.1 Требования к содержанию документов технического и рабочего проектов установлены в РД 50-34.698, соответствующими стандартами ЕСПД, ЕСКД, а также рекомендациями международных и национальных стандартов. Некоторые уточнения по наиболее важным из них приведены в данном ОРММ ИСЖТ.

5.1.2 В зависимости от объема проектирования (система, комплекс задач, АРМ) разработчик самостоятельно определяет содержание каждого документа.

5.1.3 Содержание отчетов по ГОСТ 7.32, разрабатываемых на предпроектных стадиях ("Формирование требований к АС" и "Разработка концепции АС") по набору разделов представлено в РД-34.698 (приложение 1).

ГАРАНТ:

По-видимому, в тексте предыдущего абзаца допущена опечатка. Имеется в виду "РД 50-34.698"

5.2 Требования к содержанию документов по общесистемным решениям

5.2.1 Ведомость проектов

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

Документ следует выполнять по ГОСТ 2.106.

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

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

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

Ведомость технического проекта на систему включает разделы:

- документация по общесистемным решениям;

- документация решений по организационному обеспечению;

- документация решений по техническому обеспечению;

- документация решений по информационному обеспечению;

- документация решений по программному обеспечению;

- документация решений по математическому обеспечению.

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

Пример оформления ведомости технического проекта приведен в приложении А, ведомости документов технорабочего проекта - в приложении Б, ведомости рабочей документации - в приложении В.

5.2.2 Описание информационной технологии системы

Документ предназначен для описания информационной технологии для комплексных многоуровневых и интегрированных информационных систем и включает следующие разделы:

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

- наименование системы и ее назначение;

- основные компоненты системы;

- этапы создания системы и функциональный состав задач каждого этапа.

2) Состав сообщений

Приводятся виды сообщения на всех уровнях функционирования системы.

3) Технология подготовки, формирования и передачи информации (сообщений, документов, сигналов и пр.)

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

4) Основные базы данных системы и их состав

Приводятся базы данных (сервера) как системы в целом, так и входящих в нее компонентов (подсистем, АРМ и пр.). Описывается их организация и состав, а также администрирование.

5) Принципы логического контроля и синхронизации баз данных

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

6) Описание функций системы

Приводятся реализуемые в проекте функции системы в целом и всех ее частей (подсистем, комплексов задач, АРМ и пр.) на всех уровнях решения (линейном, дорожном, сетевом). Описывается перечень выходных печатных форм (справок, отчетов и пр.).

7) Порядок взаимодействие с другими системами

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

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

5.2.3 Пояснительная записка к техническому проекту

Документ "Пояснительная записка к техническому проекту" предназначен для общего описания и обоснования решений, принятых в проекте. Разрабатывается в составе технического проекта для систем (комплексов задач, АРМ).

Состав и содержание документа:

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

- наименование разработки и ее назначение;

- наименование документов, на основании которых ведется разработка проекта системы;

- перечень организаций, участвующих в разработке;

- назначение системы (комплекса задач).

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

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

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

- перечень утвержденных методик, использованных при разработке проекта;

- решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы, подсистем;

- решения по взаимосвязи АС со смежными частями, обеспечению ее совместимости;

- краткое описание функционирования системы (комплекса задач, АРМ) в целом и по отдельным частям, ее диагностирование;

- состав функций, комплексов задач (задач), реализуемых системой (подсистемой);

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

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

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

В разделе приводят в виде иллюстраций другие документы, которые допускается включать по ГОСТ 34.201.

4) Мероприятия по подготовке объекта автоматизации к вводу (по унификации информации для обработки на ЭВМ, по созданию необходимых подразделений, по изменению структуры объекта автоматизации и пр.).

5.2.4 Описание автоматизированных функций

Документ "Описание автоматизированных функций" разрабатывается для систем типа АСУТП, АСУП и включающих подсистемы, АРМы и другие компоненты. Состав разделов документа:

- исходные данные (перечень используемых при разработке функций системы материалов и документов);

- цели ИС и автоматизированные функции (приводится их описание);

- характеристика функциональной структуры (перечень подсистем с описанием функций каждой из них, описание разделения операций между техническими средствами и человеком);

- типовые решения (при наличии).

Подробное описание разделов в РД 50-34.698, п. 2.5.2-2.5.5.

5.2.5 Описание постановки задачи (комплекса задач)

Документ "Описание постановки задачи" является обязательной составной частью технической документации на типовые комплексы задач, задачу и такие компоненты информационной системы, как АРМ и др.

Допускается разрабатывать документ "Описание постановки задачи" на группу задач одного комплекса или на несколько комплексов задач, имеющих общий алгоритм функционирования. При этом необходимо соблюдать требования к оформлению данного документа в соответствии с РД 50-34.698 (п. 2.6.2-2.6.4).

Документ должен содержать следующие разделы:

- характеристика комплекса задач (задачи);

- архитектура построения распределенных приложений;

- выходная информация (на уровне документов, сообщений, массивов);

- входная информация (на уровне документов, сообщений, массивов);

- нормативно-справочная информация;

- меры по повышению надежности функционирования комплекса задач (задачи);

- описание алгоритма;

- описание результатов имитационного (имитационно-физического) моделирования.

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

Совместно с "Техническим заданием" на разработку комплекса задач (АРМ, задачу) документ определяет требования к видам обеспечения. "Описание постановки задачи разрабатывается:

1) в составе технического (технорабочего) проекта на систему (комплекс задач, автоматизированное рабочее место, задачу);

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

Содержание разделов:

1) В разделе "Характеристика комплекса задач" приводится следующая информация:

- назначение комплекса задач;

- комплексы задач (задачи, АРМы), на которые распространяется этот документ;

- перечень объектов (технологических объектов управления, подразделений предприятий), при управлении которыми решают этот комплекс задач;

- базы данных, используемые при решении задачи;

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

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

- условия, при которых прекращается решение функционирование задач автоматизированным способом, и ссылка на утвержденную технологию работы в условиях отказа технических и программных средств;

- связь данного комплекса задач с другими задачами и комплексами системы;

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

2) Раздел "Архитектура построения распределенных приложений" определяет протоколы и интерфейсы взаимодействия клиентских и серверных частей приложений между собой и с программными средствами среды распределенной обработки данных при выполнении ими функций поддержки интерфейсов пользователя. Приводятся компоненты клиентской части и представляемые средства пользовательского интерфейса (наличие управления окнами, использование готовых графических символов (икон), манипулирование графическими объектами и окнами посредством "мыши", объектно- и проблемно-ориентированное проектирование диалоговых систем и пр.).

3) Раздел "Выходная информация" содержит:

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

По каждому документу (массиву, сообщению) указывают:

- идентификатор;

- форму представления (документ, видео-кадр, массив, сообщение, сигнал управления и пр.)

- периодичность выдачи;

- сроки выдачи и допустимое время задержки решения;

- получателей и назначение выходной информации.

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

- наименование;

- идентификатор;

- требования к точности и надежности (при необходимости).

Допускается ссылка на документы с их описанием.

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

4) Раздел "Входная информация" включает:

- перечень и описание входных документов (массивов, сообщений и пр.) с указанием их идентификаторов, формы представления, сроков и частоты поступления, времени хранения;

- перечень и описание структурных единиц информации входных;

- документов (массивов, сообщений и пр.) или ссылку на документы, содержащие эти данные, а также виды логического контроля.

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

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

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

5) Раздел "Нормативно-справочная информация" включает:

- перечень классификаторов (общероссийских, отраслевых, локальных);

- словари;

- массивы (таблицы, справочники);

- состав реквизитов словарей и массивов, используемых при решении задачи.

Описание нормативно-справочной информации приводится в форме таблиц.

6) Раздел "Описание алгоритма решения" включает:

- математическое описание (при необходимости);

- алгоритм решения.

В подразделе "Математическое описание" приводится математическая модель или экономико-математическое описание процесса (объекта), перечень принятых допущений и оценки соответствия принятой модели реальному процессу (объекту) в различных режимах и условиях работы, сведения о результатах научно-исследовательских работ, если они использованы для разработки алгоритма.

В подразделе "Алгоритм решения" приводится:

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

- описание блоков, реализуемых промышленными программными продуктами;

- описание алгоритмов решения комплекса задач (задачи), реализуемых современными программными средствами (включая CASE-технологии) с указанием логических операций, соотношений для контроля вычислений, требования к точности расчетов и контроля достоверности вычислений, последовательности формирования выходной информации;

- описание параметров настройки алгоритмов, учитывающих конкретные условия объекта, на котором внедряется система.

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

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

Алгоритм в виде схемы выполняется по правилам, установленным ГОСТ 19.002 и ГОСТ 19.005, в виде таблиц и текстовых описаний - по ГОСТ 2.105.

7) В разделе "Меры по повышению надежности функционирования задачи" приводятся:

- способы использования хранимой информации при изменении инфраструктуры объектов автоматизации;

- порядок автоматического протоколирования хода решения задачи с приведением образцов протоколов для каждого этапа решения;

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

8) Раздел "Описание результатов имитационного (имитационно-физического) моделирования разрабатывается при необходимости и включает:

- общее описание метода моделирования;

- описание исходных данных для моделирования;

- описание количественных характеристик функционирования задачи по результатам моделирования, производительности, времени реакции и др.;

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

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

5.2.6 Паспорт

Документ разрабатывается в соответствии с РД 50-34.698-90 (п. 2.8) для ИС, ее частей и компонентов. Информация, помещенная в данном документе, включается Отраслевым фондом алгоритмов и программ МПС (ОФАП МПС) при регистрации системы в Информационно-справочную систему состояния средств информатизации и телекоммуникаций на железнодорожном транспорте (ИССИТ)"

Документ содержит разделы:

1) Полное название автоматизированной системы (задачи, АРМ).

2) Сокращенное название.

3) Основные функции.

4) Входная информация.

5) Выходная информация.

6) Состав АС (другие системы, общесистемные компоненты, АРМ и пр.).

7) Состав НСИ.

8) Организация-заказчик.

9) Источник финансирования.

10) Объем финансирования (млн руб.).

11) Вид плана выполнения работ.

12) Головной разработчик.

13) Соисполнители.

14) Дата утверждения ТЗ.

15) Дата и N акта о сдаче в опытную эксплуатацию на головном объекте.

16) Дата и N акта о сдаче в постоянную эксплуатацию на головном объекте.

17) Головной объект внедрения.

18) Другие объекты внедрения

19) Уровень применения.

20) Предметная область.

21) Класс системы.

22) Режим функционирования.

23) Временные характеристики.

24) Тиражируемость (возможность внедрение на нескольких объектах).

25) Вхождение в другие системы (перечень).

26) Периодичность решения.

27) Тип ЭВМ.

28) Тип и версия ОС.

29) Языки программирования.

30) Признак наличия средств генерации.

31) Признак работы в сетях.

32) Виды каналов связи (для АРМ).

33) Тип модема (для АРМ)

34) Протоколы связи.

35) Требуемый размер оперативной памяти.

36) Требуемый размер памяти на магнитных носителях.

37) Организация-изготовитель.

38) Организация-держатель подлинника.

39) Признак наличия документации в ОФАП или его отделениях.

40) Признак наличия ПО в ОФАП или его отделениях.

41) Вид носителя информации программного обеспечения.

42) Вид носителя документации.

43) Наличие лицензии (N договора) на используемые операционные системы, СУБД и инструментальные средства.

44) Конечные пользователи.

45) Версия ПО.

46) Почтовый адрес головного разработчика.

47) Фамилии основных разработчиков и их рабочие телефоны.

48) Контактный телефон.

5.2.7 Общее описание системы

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

- назначение системы (вид деятельности, для которой предназначена система; перечень объектов автоматизации, на которых может использоваться система; перечень функций, реализуемых системой);

- описание системы (структура системы и назначение ее частей);

- описание взаимосвязей ИС с другими системами (перечень систем, описание связей и их регламента);

- описание подсистем (при необходимости).

Подробное описание разделов в РД 50-34.698 (пп. 2.11.2-2.11.5).

5.2.8 Программа и методика испытаний

Программа испытаний должна содержать перечни конкретных проверок:

- соответствие ТЗ;

- комплектность системы (задачи, АРМ и др.);

- комплектность и качество документации;

- комплектность, достаточность состава и качество программных средств и программной документации;

- количество и квалификация обслуживающего персонала;

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

- контролепригодность системы (приводится контрольный пример);

- выполнение требований техники безопасности, противопожарной безопасности, промышленной санитарии, эргономики;

- функционирование системы с применением программных средств.

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

Программа испытаний должна охватывать:

- объект испытаний;

- цель испытаний;

- общие положения;

- условия и порядок проведения испытаний;

- материально-техническое обеспечение испытаний;

- метрологическое обеспечение испытаний;

- отчетность.

Описание контрольного примера приводится в качестве приложения.

Подробное содержание этих разделов в РД 50-34.698 (п.п. 2.14.7-2.14.17).

5.2.9 Схема организационной структуры

Схема структуры содержит состав подразделений (лиц), участвующих в функционировании ИС, их основные функции и связи между ними.

5.2.10 Описание постановки общесистемного проектного решения по базе данных

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

1) Введение (обоснование и краткая характеристика решений по базе данных).

2) Инфологическая модель предметной области и ее отображение в среду, поддерживаемую выбранной СУБД ( описываются элементы модели).

3) Описание логической структуры базы данных (состав информационных объектов; структуризация данных, содержащихся в информационных объектах; представление структурных связей с помощью средств СУБД и пр.)

4) Описание внутренней схемы базы данных (способы организации данных в среде хранения; состав хранимых записей, их формат, размеры блока, ключей, форматов представлений полей, количество экземпляров записей; выбор метода организации и доступа к данным; определение объемных характеристик хранимых данных; выбор средств реализации логических связей и пр.)

5) Описание представлений данных для приложений.

6) Описание состава функций, поддерживаемых СУБД и пакетами прикладных программ приложений окружения, а также функций, реализуемых средствами прикладного программного обеспечения. Описание генерации и настройки.

7) Описание функций СУБД по обеспечению следующих задач:

ввода сообщений и документов;

контроля сообщений и документов;

исправления вводимых сообщений и документов;

управления потоком ввода документов и сообщений;

загрузки данных из множества документов и сообщений в базу данных с одновременным контролем их достоверности;

актуализации базы данных;

организации контрольных точек;

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

ведение системного журнала;

реорганизации баз данных;

редактирования и форматирования выходных документов и сообщений;

обеспечение безопасности, в том числе целостности;

тестирования;

тестирования и отладки программ пользователя и пр.

8) Расчет потребностей в оборудовании и ресурсах вычислительной системы (приводятся решения по структуре КТС, описания методов обмена данными, защиты; расчет потребности в объеме машинных носителях, объемов оперативной памяти, организационно-техническом оснащении рабочих мест администратора и пользователей, расчет численности персонала, обслуживающего базу данных и пр.)

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

5.3 Требования к содержанию документов с решениями по организационному обеспечению

5.3.1 Описание организационной структуры

Документ содержит разделы:

- изменения в организационной структуре управления объектом;

- организация подразделений;

- реорганизация существующих подразделений управления.

Подробное описание разделов в РД 50-34.698 (пп. 3.1.2-3.1.4).

5.3.2 Методика (технология) автоматизированного проектирования

Документ разрабатывается для систем автоматизированного проектирования и содержит разделы:

- общие положения;

- постановка задачи;

- методика проектирования;

- исходные данные;

- проектные процедуры;

- оценка результатов.

Подробное описание разделов в РД 50-34.698 (пп. 3.2.2-3.2.8).

5.3.3 Технологическая инструкция

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

Структуру документа устанавливает разработчик в зависимости от содержания операций.

5.3.4 Руководство пользователя

Документ содержит разделы:

- введение;

- назначение и условия применения;

- подготовка к работе;

- описание операций;

- аварийные ситуации;

- рекомендации по освоению.

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

В разделе " Назначение и условие применения" описывают:

- виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;

- условия функционирования системы (вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, база данных, требования к подготовке специалистов и пр.)

В разделе "Подготовка к работе" указывают:

- состав и содержание дистрибутивного носителя данных;

- порядок загрузки данных и программ;

- порядок проверки работоспособности.

В разделе "Описание операций" указывают:

- описание всех выполняемых функций, задач (комплексов задач), процедур;

- описание операций технологического процесса обработки данных для выполнения функций, задач (комплексов задач), процедур.

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

Кроме этого, должны быть описаны:

- соответствие между элементами интерфейсов пользователя (экранными формами) и типовыми процедурами;

- последовательность допустимых операций и переходы между экранными формами (навигация экранов);

- форма идентификации ошибочных действий и/или ситуаций;

- формы входных и выходных документов.

В разделе "Аварийные ситуации" указывают действия в случае:

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

- восстановления программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;

- обнаружения несанкционированного вмешательства в данные;

- других аварийных ситуациях.

5.3.5 Описание технологического процесса обработки данных (включая телеобработку)

Документ содержит разделы:

- технологический процесс сбора и обработки данных на базе серверов, рабочих; станций и периферийных устройств при децентрализованной обработке данных;

- перечень документации, сопровождающий каждый этап технологического процесса.

5.3.6 Руководство администратора системы

Документ содержит разделы:

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

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

- ввод заданий и выработка запроса на их выполнение;

- представление результатов обработки заданий;

- способы и формы контроля исполнения заданий;

- динамические управления процессом реализации заданий;

- порядок синхронизации баз данных.

В приложении к "Руководству администратора" должны быть разработаны документы, которые определяют:

- управление программами и базами данных;

- процессы управления объектами и порядок реализации каждой функции;

- информационную модель объектов и их атрибутов и операций;

- системы имен объектов и атрибутов для их идентификации;

- руководство для формализации и описания объектов управления;

- взаимосвязь видов управляющей информации;

- формализация непосредственной передачи управляющей информации;

- передаваемые типы данных, формализующие объекты, их состояния, атрибуты, операции и извещения;

- классификатор объектов управления, отражающий взаимосвязь между классами объектов управления и правилами их применения.

5.3.7 Документ "Руководство администратора БД"

Документ включает:

- Описание действий по обеспечению технологического процесса функционирования БД и описание действий при его нарушении.

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

- Права и обязанности администратора БД.

5.4 Требования к содержанию документов с решениями по техническому обеспечению

5.4.1 Описание комплекса технических средств

Документ содержит разделы:

- общие положения;

- структура комплекса технических средств;

- средства вычислительной техники;

- аппаратура передачи данных.

Подробное описание разделов в РД 50-34.698 (пп. 4.2.2-4.2.5).

ГАРАНТ:

Нумерация разделов приводится в соответствии с источником

5.4.3 Инструкция по эксплуатации комплекса технических средств

Документ содержит разделы:

- общие сведения;

- меры безопасности;

- порядок работы;

- проверка правильности функционирования;

- указания о действиях в разных режимах.

Подробное описание разделов в РД 50-34.698 (пп. 4.19.2-4.19.6).

5.4.4 Схема соединений внешних проводок

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

Подробное описание в пп. 4.10.1-4.10.2 РД 50-34.698.

5.4.5 Схема подключения внешних проводок

Подробное описание в пп. 4.11.1-4.11.2 РД 50-34.698.

5.5 Требования к содержанию документов с решениями по информационному обеспечению

5.5.1 Перечень входных сигналов и данных

Документ содержит разделы:

- перечень входных сигналов;

- перечень входных данных.

"Входные сигналы":

- для аналогового сигнала - наименование измеряемой величины, единицы измерения, диапазон, требования к точности и периодичности, тип сигнала;

- для дискретного сигнала - наименование, разрядность и периодичность, тип сигнала;

- для сигнала "да-нет" - источник формирования и смысловое значение сигнала.

"Входные данные":

- наименование, кодовое обозначение и значность реквизитов входных данных;

- наименования и кодовые обозначения документов или сообщений с этими данными.

5.5.2 Перечень выходных сигналов (документов)

Документ содержит разделы:

- перечень выходных сигналов;

- перечень выходных документов.

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

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

5.5.3 Описание информационного обеспечения (ИО) системы

Документ содержит разделы:

- состав, структура и принципы организации информационного обеспечения;

- организация информационного обеспечения;

- организация сбора и передачи информации;

- построение системы классификации и кодирования;

- организация внутримашинной информационной базы системы (применяемые СУБД; состав; структура, объем информационной базы на уровне баз данных; решения по поддержанию внутримашинной базы в достоверном состоянии)

- организация внемашинной информационной базы системы (состав, объем, организация и обслуживание нормативно-справочной информации).

- состав и структура данных для настройки системы на объект;

- решения, обеспечивающие достоверность внемашинной информационной базы.

Подробное описание разделов в РД 50-34.698 (пп. 5.3.2-5.3.8).

5.5.4 Состав выходных данных (сообщений, документов)

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

5.5.5 Описание организации информационной базы (ИБ)

Документ содержит описание логической и физической структуры базы данных и состоит из трех частей:

- описание внутримашинной ИБ (состав и структура);

- описание внемашинной ИБ (состав и структура)

- организация ведения информационных баз.

Подробное описание разделов в РД 50-34.698-90 (п. 5.5.3-5.5.7).

5.5.6 Описание систем классификации и кодирования

Документ содержит перечень применяемых в АС зарегистрированных классификаторов, описание метода кодирования, структуры и длины кода, указания о системе классификации и другие сведения.

5.5.7 Чертеж формы документа (видео-кадра)

В документе должно быть приведено изображение формы документа или видео-кадра в соответствии с требованиями УСД Р50-77 и необходимые пояснения.

5.5.8 Каталог баз данных

Каталог БД содержит перечень объектов предметной области АС, информация о которых включена в БД.

5.5.9 Состав выходных данных (сообщений)

Документ разрабатывается на стадии "Рабочая документация" и содержит перечень выходных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений с этими данными.

5.5.10 Инструкция по формированию и ведению базы данных (набора данных)

Документ содержит разделы:

- состав первичных документов и правила подготовки данных;

- порядок и средства заполнения БД;

- процедуры изменения и контроля БД;

- порядок и средства ведения БД.

Подробное описание разделов в РД 50-34.698 (пп. 5.12.2-5.12.5).

5.5.11 Документ "Описание регулярных запросов к базе данных (БД)

Документ содержит перечень запросов автоматизируемых процессов к БД, включая формализованные описания запросов в терминах объектов и атрибутов (форма, размерность, способ доступа, упорядоченность и т.д.)

5.6 Требования к содержанию документов с решениями по программному обеспечению

5.6.1 Описание программного обеспечения

Документ содержит разделы:

- структура ПО;

- функции частей ПО;

- методы и средства разработки ПО;

- пользовательский интерфейс с программными средствами;

- операционная система;

- средства, расширяющие возможности ОС.

Подробное описание разделов в РД 50-34.698 (пп. 6.1.2-6.1.7).

5.7 Требования к содержанию документов с решениями по математическому обеспечению

5.7.1 Описание алгоритма (проектной процедуры)

Документ содержит разделы:

- назначение и характеристика алгоритма;

- используемая информация;

- результаты решений;

- математическое описание;

- алгоритм решения.

Подробное описание разделов в РД 50-34.698 (пп. 7.1.3.-7.1.9).

Алгоритм в виде схемы выполняют по правилам, установленным ГОСТ 19.002 или 19.005.

Алгоритм в виде таблиц в соответствии с ГОСТ 2.105.

При объединении с документом "Описание постановки задачи" первые три раздела опускаются.

5.8 Требования к документам по описанию локальных вычислительных сетей ПЭВМ (ЛВС)

5.8.1 Описание работы локальных вычислительных сетей в АС приводится в документах:

- Описание комплекса технических средств.

- Описание программного обеспечения.

- Описание информационного обеспечения.

- Руководство пользователя.

5.8.2 В документе "Описание комплекса технических средств" в разделе "Средства вычислительной техники" приводят описание локальной вычислительной сети, в том числе:

- общую характеристику технических средств локальной сети (типы ПЭВМ, их количество; типы модемов; конфигурация ЛВС; серверы; терминальное оборудование; протоколы обмена информацией, схемы подключения и пр.).

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

5.8.4 В документ "Описание информационного обеспечения" включают раздел "Распределенные базы данных в локальной сети ПЭВМ" (имена предметных баз данных, форма и место обработки данных и пр.)

5.8.5 "Руководство пользователя" для сервера включает разделы:

- назначение сервера;

- организация работы сервера;

- настройка сервера;

- описание работы оператора, обслуживающего сервер;

- электронная почта.

5.8.6 Допускается разработка самостоятельного документа с кодом П10 "Описание локальной вычислительной сети в АС" с включением информации из приведенных выше разделов.

5.9 Требования к содержанию документации на программные средства и изделия, имеющие самостоятельное применение

5.9.1 Требования к содержанию и оформлению программных документов приведены в ГОСТ 19.101-77, 19.105-78, 19.106-78.

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

5.9.2 Техническое задание на проектирование программных средств (ПС)

Требования к техническому заданию (ТЗ) приведены в ГОСТ 19.201.

ТЗ включает поэтапно уточняющиеся и детализирующиеся разделы:

- полное наименование проекта ПС;

- назначение и цель разработки (развития) ПС;

- основание для выполнения и финансирования проекта ПС;

- заказчик проекта;

- головной исполнитель и соисполнители проекта;

- общие сроки выполнения проекта;

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

- характеристики объекта информации;

- общие требования к программному средству:

- требования к программному средству в целом;

- требования к функциям и основным задачам проекта ПС;

- требования к внешней среде проекта ПС;

- детальные спецификации требований к функциям, компонентам и эксплуатационным характеристикам ПС;

- специальные требования к аппаратной и оперативной платформам для реализации ПС;

- требования к оформлению и содержанию эксплуатационной и технологической документации;

- требования к составу и содержанию работ по внедрению ПС в эксплуатацию;

- этапы и сроки выполнения основных работ;

- ожидаемые результаты и форма их представления;

- порядок контроля и приемки результатов работы;

- предложения по применению и развитию проекта ПС.

5.9.3 Описание применения

Требования к содержанию документа приведены в ГОСТ 19.502. Согласно ГОСТ 19.101 этот документ является эксплуатационным. Его основные пользователи - лица, занимающиеся применением программного средства для решения задач, осуществляющие сопровождение, разрабатывающие технологию применения программного средства для решения конкретных задач, а также руководители, определяющие целесообразность применения данного программного средства для решения конкретных задач.

Согласно требованиям ГОСТ 19.502 документ должен состоять из следующих разделов:

- назначение программного средства;

- условия применения;

- описание задачи;

- входные и выходные данные.

Разрешается объединять небольшие по объему разделы и вводить дополнительные разделы.

5.9.3.1 В разделе "Назначение программного средства" излагается область применения программного средства и следующие эксплуатационные характеристики:

- объем программного обеспечения;

- минимальный объем оперативной памяти;

- требуемый объем на магнитных носителях;

- языки программирования;

- платформа, на базе которой может работать программное средство.

Целесообразно изложить сведения о надежности программы, а для программ решения математических задач вычислительного характера - точность вычисления. Приводится скорость работы программ, время счета контрольных примеров.

5.9.3.2 В разделе "Условия применения" описываются условия, необходимые для выполнения программ:

- требования к необходимым для данной программы техническим средствам;

- общие характеристики входной и выходной информации;

- требования и условия технического, организационного и технологического характера.

При описании требований организационного характера описываются требования к организации применения и сопровождения программ.

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

5.9.3.3 В разделе "Описание задачи" описываются постановка задачи и методы ее решения.

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

5.9.3.4 В разделе "Входные и выходные данные" приводятся сведения о выходных и входных данных на функциональном уровне, но с достаточной степенью подробности. Информация должна быть достаточная, чтобы возможно было разделить все данные, указанные в постановке задачи и описании метода на входные, промежуточные (вспомогательные) и выходные.

5.9.4 Описание комплекса программ (программы)

5.9.4.1 Требования к содержанию документа приведены в ГОСТ 19.402. Согласно ГОСТ 19.101 этот документ не является эксплуатационным и поэтому не может объединяться с другими документами. Его основные пользователи - лица, занимающиеся сопровождением программного обеспечения.

Документ "Описание комплекса программ" содержит сведения по комплексу в целом и по отдельным программам в отдельности.

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

Раздел "Описание комплекса программ в целом" включает:

- общие сведения о комплексе программ (обозначение и полное наименование комплекса программ, языки программирования, размер программы в Кбайтах в десятичной системе исчисления, объем оперативной памяти и памяти на дисках, временные характеристики, фамилии разработчиков).

- функциональное назначение комплекса программ и составляющих программ;

- описание логической структуры и алгоритмов комплекса программ в целом и каждой функциональной группы (управляющей, функциональной, сервисной, обеспечивающей интерфейс с пользователями и пр.), связь с другими программами;

- особенности функционирования комплекса (методы обеспечения надежности, способы защиты информации от несанкционированного доступа и пр.);

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

- описание входных и выходных данных (массивов, сообщений, документов, показателей и пр.) - их расположение, объем и форма представления;

- описание отдельных программ комплекса.

5.9.4.3 В разделе "Общие сведения", описывающем отдельную программу, указываются:

- обозначение программы;

- наименование программы;

- программное обеспечение, необходимое для функционирования программы;

- операционные системы, СУБД и пр.;

- языки программирования.

5.9.4.4 В разделе "Функциональное назначение программы" указываются классы решаемых задач и (или) назначение программы (ее функции) и сведения о функциональных ограничениях на применение.

5.9.4.5 В разделе "Описание логической структуры программы" указываются:

- алгоритм программы (операции программы, входные точки);

- используемые методы;

- структура программы с описанием функций составных частей и связи между ними;

- связи программы с другими программами.

Способ описания алгоритма - произвольный. Рекомендуется его оформлять в виде блок-схемы программы.

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

Главное назначение описания структуры - уточнение того, из каких частей состоит программа и как они связаны между собой.

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

5.9.4.6 В разделе "Вызов и загрузка программы" указываются:

- способ вызова с соответствующего носителя (конкретные операторы, директории);

- входные точки в программу;

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

5.9.4.7 В разделе "Входные данные программы" указываются:

- характер данных;

- организация данных;

- предварительная подготовка данных;

- формат, описание данных, способ кодировки.

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

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

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

Разрешается объединять разделы, если они небольшие по объему.

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

5.9.5 Руководство программиста

Требования к содержанию документа "Руководство программиста" приведены в ГОСТ 19.504. Согласно ГОСТ 19.101 этот документ может объединяться с документами:

- "Руководство оператора".

- "Руководство системного программиста".

- "Описание применения".

- "Описание языка".

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

5.9.5.1 Согласно ГОСТ 19.504 документ должен состоять из следующих разделов:

- назначение и условия применения программы (комплекса программ);

- характеристики программы (временные характеристики, объем программы, режим работы и др.);

- обращение к программе (процедуры вызова программы, система меню и др.);

- входные и выходные данные (организация и кодирование);

- сообщения (тексты сообщений).

Разрешается объединять небольшие по объему разделы.

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

Если в программе не предусмотрены сообщения, то указывают об этом явно:

"Сообщения программисту (оператору) программой не предусмотрены."

5.9.5.2 В данном документе излагается эксплутационное назначение программ (комплекса программ).

5.9.6 Руководство системного программиста

Требования к содержанию документа приведены в ГОСТ 19.503-79. Он разрабатывается в основном при оформлении программного обеспечения ИС на базе ЭВМ типа Mainframe.

Согласно ГОСТ 19.101 этот документ является эксплуатационным. Он может быть объединен с другими программными документами:

- "Руководство программиста".

- "Описание применения".

- "Руководство оператора".

Основные пользователи этого документа - системные программисты.

5.9.6.1 Разделы документа "Руководство системного программиста" включают:

- общие сведения о комплексе программ;

- структура комплекса программ;

- настройка комплекса программ;

- проверка программ;

- дополнительные возможности (при необходимости);

- сообщения системному программисту (при необходимости).

Разрешается объединять небольшие по объему разделы.

Допускается вводить дополнительные разделы.

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

5.9.6.3 В разделе "Структура комплекса программ" приводятся сведения о структуре комплекса программ, ее составных частях, связях между составными частями и о связях с другими программами.

5.9.6.4 В разделе "Настройка программ" должно быть приведено описание действий по настройке программ на условия конкретного применения: состав КТС, выбор функций, способы представления входных данных, технология вычислений.

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

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

Контрольный пример должен иллюстрировать возможность выполнения каждой функции программы (комплекса программ). В контрольном примере должны быть задействованы не менее одного раза все исходные данные. Среди результатов решения должно быть приведено не менее одного раза каждое выходное данное.

Каждый модуль обязан выполняться не менее одного раза при решении.

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

5.9.6.7 В разделе "Сообщения системному программисту" должны быть указаны тексты сообщений, описания их содержания и действий, которые необходимо предпринять по этим сообщениям.

5.9.7 Руководство оператора

Требования к содержанию по ГОСТ 19.505:

- назначение комплекса программ;

- условия выполнения комплекса программ (минимальный состав оборудования, правила использования комплексом программ внешних устройств и варианты применения и замены, наличие необходимых программных средств);

- порядок выполнения заданий (последовательность действий; описание функций, формата и возможных вариантов команд для осуществления загрузки и выполнения программ; ответы на команды загрузки и управления);

- сообщения оператору (тексты сообщения для оператора, описание действий оператора).

Согласно ГОСТ 19.101 этот документ является эксплутационным. Основные пользователи - операторы ЭВМ типа Mainframe. При разработке программ на базе ПЭВМ этот документ не требуется, но может быть разработан, при необходимости, в случае создания систем с большим объемом вводимых данных.

5.9.8 Текст программы

Требования к содержанию документа "Текст программы" установлены ГОСТ 19.401.

Согласно ГОСТ 19.101 этот документ не является эксплутационным и не может объединяться с другими документами.

Документ нужен лицам, осуществляющим сопровождение программы.

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

5.9.8.1 Наименование разделов этого документа не стандартизованы. Наименование разделов дает автор программы.

5.9.8.2 Допускается для документа "Текст программы" оформлять титульный лист и аннотацию. В аннотации описывается содержимое магнитного носителя (МЛ, ГМД, CD ROM и пр.), а на титульном листе в поле "вид носителя данных" указывать:

- "Магнитная лента";

- "Гибкий магнитный диск";

- "Компакт-диск".

Кроме того, на титульном листе в поле "вид документа" должна быть указана форма представления программ. Например, "Текст программы. Дистрибутивная система", или "Текст программы. Библиотека исходных модулей".

5.9.8.3 В исходные тексты модулей рекомендуется включать вводные комментарии, которые отражают:

- имя файла (модуля);

- функциональное назначение файла (модуля);

- структуру файла (модуля);

- описание входных и выходных параметров.

5.9.9 Спецификация

Требования к содержанию документа "Спецификация" установлены ГОСТ 19.202 и ГОСТ 19.104.

Согласно ГОСТ 19.101 этот документ не является эксплутационным и не может быть объединен с другими документами.

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

5.9.9.1 Документ содержит разделы:

- документация;

- комплексы;

- компоненты.

5.9.9.2 Спецификация на компонент должна иметь только один раздел "Документация".

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

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

- документация;

- компоненты.

Дополнительные разделы в спецификацию вводить нельзя.

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

- "Обозначение".

- "Наименование".

- "Примечание".

Заголовки подчеркиваются в документах, выполненных печатным способом.

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

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

5.9.9.5 Пример оформления документа "Спецификация" приведен в приложении Г к данному документу.

5.9.10 Объединение программных документов

Допускается объединять любые эксплуатационные документы, за исключением ведомости эксплуатационных документов и формуляра.

Объединяться могут следующие документы:

- Описание применения.

- Руководство системного программиста.

- Руководство программиста.

- Руководство оператора.

- Описание языка

- Руководство по техническому обслуживанию.

Не подлежат объединению "Текст программы", "Описание программы", "Спецификация".

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

Объединенному документу присваивается наименование и обозначение одного из объединенных документов.

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

Оформление программных документов осуществляется в соответствии с ГОСТ 19.103-77.

5.9.11 Руководство оперативного пользователя

Руководство пользователя mainframe должно содержать разделы:

1) введение:

- область применения;

- краткое описание возможностей;

- требования к уровню подготовки пользователя;

- перечень эксплуатационных документов, с которыми необходимо ознакомиться пользователю;

2) назначение и условия применения:

- виды деятельности и функции, для автоматизации которых предназначено данное программное средство;

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

3) подготовка к работе:

- состав и содержание дистрибутивного носителя данных;

- порядок загрузки данных и программ;

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

4) описание операций - для каждой операции обработки данных должно быть указано:

- наименование;

- условия, при соблюдении которых возможно выполнение операций;

- подготовительные действия;

- основные действия в требуемой последовательности;

- заключительные действия;

- ресурсы, расходуемые на операцию;

- описание всех выполняемых функций, задач, комплексов задач, процедур;

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

5) аварийные ситуации:

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

- действия по восстановлению программ и/или данных при отказе или обнаружении ошибок в данных;

- действия в случае обнаружения несанкционированного вмешательства в данные;

6) рекомендации по освоению, включая описание контрольного примера, правила его запуска и выполнения.

5.9.12 Руководство по инсталляции

Руководство по инсталляции системы должно включать разделы:

1) Введение (идентификация системы и общие положения).

2) Область применения.

3) Нормативные ссылки.

4) Обозначения и сокращения.

5) Порядок установки:

- требования к установке системы (требования к ресурсам и программному обеспечению сервера базы данных; требования к базе данных; требования к ресурсам и программному обеспечению "клиента" и пр.);

- установка системы: состав и структура дистрибутива; установка серверной части; установка клиентского рабочего места; определение пути доступа по сети к серверу; установка программного обеспечения клиентского рабочего места; загрузка необходимых компонентов системы (шрифтов и пр.), проверка функционирования программно-технического комплекса.

- настройка системы: настройка серверной части системы; настройка клиентской части системы.

6) Приложения (скрипт для создания базы данных, содержание файла настройки и пр.).

6 Техническое задание на создание АС

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

6.1.1 ТЗ на систему является основным документом, определяющим требования и порядок создания АС, в соответствии с которым проводится разработка и приемка АС.

6.1.2 ТЗ на АС разрабатывается на систему в целом или на части:

- подсистемы АС;

- комплексы задач АС;

- базу данных;

- на комплектующие средства технического обеспечения и программно-технические комплексы в соответствии со стандартами ЕСКД;

- на программные средства в соответствии со стандартами ЕСПД;

- на информационные изделия в соответствии с ГОСТ 19.201 и НТД в АСУЖТ.

6.2 Состав и содержание

ТЗ на АС содержит следующие разделы:

1) общие сведения;

2) назначение и цели создания (развития) системы;

3) характеристика объектов автоматизации;

4) требования к системе;

5) состав и содержание работ по созданию системы;

6) порядок контроля и приемки системы;

7) требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие;

8) требования к документированию;

9) источники разработки.

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

В ТЗ на части системы не включают разделы, дублирующие содержание разделов ТЗ на АС в целом.

Подробное содержание разделов ТЗ - ГОСТ 34.602, пп. 2.3-2.12.

6.3 При создании и внедрении типовых систем возможна разработка технического задания по настройке этих систем к условиям объекта внедрения.

В этом случае ТЗ должно содержать следующие разделы:

- Наименование системы;

- Основание для внедрения;

- Назначение и цель системы;

- Требования к системе в целом:

а) функциональный состав системы;

б) общий перечень управляемых объектов с указанием признаков необходимости ввода в действие на них отдельных компонентов системы;

в) общие требования к объемам внедрения: (количество информационных пунктов, подлежащих оснащению техническими средствами; количество абонентов (рабочих станций пр.); количество выходных документов (по запросу, регламенту пр.).

- Требования к видам обеспечения:

а) требования к программному обеспечению (типовые операционные системы и общесистемное программное обеспечение);

б) требования к информационному обеспечению (междорожный обмен и др.);

в) требования к составу технических средств (тип ЭВМ, объем ОП, наличие каналов связи и терминального оборудования).

- Требования к составу, содержанию работ по подготовке объектов к вводу системы в действие.

- Порядок приемки системы в постоянную эксплуатацию.

6.4 В ряде случаев допускается разрабатывать частные ТЗ.

Это осуществляется при разработке новых крупных частей проектируемой АС.

6.5 При модернизации систем разрабатывается дополнение к ТЗ, в котором находят свое выражение вопросы развития конкретной АС или ее компонентов.

6.6 Порядок оформления ТЗ приведен в ОРММ ИСЖТ 2.02-00 "Порядок представления, согласования и утверждения документов, разрабатываемых при создании информационных систем"

7 Требования к оформлению технической документации на информационные системы

7.1 Документация технического проекта и рабочая документация, включая программную, выполняются на листах без рамок с разработкой:

- листа утверждения (при необходимости);

- титульного листа;

- последующих листов проекта.

Необходимость выполнения титульного листа или листа утверждения документов зависит от необходимости согласования и утверждения документов. Подробно порядок оформления этих листов приведен в ОРММ ИСЖТ 2.02-00 "Порядок представления, согласования и утверждения документов, разрабатываемых на железнодорожном транспорте"

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

7.2 Оформление текстовых документов производится в соответствие с ЕСКД:

- ГОСТ 2.105 Общие требования к текстовым документам.

- ГОСТ 2.106 Текстовые документы.

- ГОСТ 2.108 Спецификация.

- ГОСТ 2 Ведомость держателей подлинников.

- ГОСТ 2.004 Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ.

7.3 Программная документация оформляется по требованиям ЕСПД. Отсутствуют линии форматки и сложные штампы. Оставшуюся вертикальную графу для регистрации документов допускается не делать, а печатать программные документы на чистых листах бумаги.

Разрешается объединять титульный лист и лист утверждения.

7.4 Системы, имеющие в своем составе изделие ("железо") и программную документацию, например, тренажеры, должны иметь в своем составе два комплекта документации: изделие - по ЕСКД и программы - по ЕСПД. Связующий их документ - "Руководство пользователя".

7.5 Прохождение нормоконтроля технической документации обязательно.

7.6 Автоматизированные системы научно-технической информации (АСНТИ) и информационно-поисковые системы (ИПС) по составу и оформлению отличаются от других АС. По усмотрению разработчика, как относящиеся к АСНТИ, они могут быть оформлены в виде отчета по ГОСТ 7.32 (ИСО 5960-1982) "Отчет о НИР" с главами, соответствующими документам серии "Информационная технология. Комплекс стандартов и руководящих документов на АС" (КС АС).

7.7 При издании тезаурусов, глоссариев и тематических рубрикаторов следует использовать издательские ГОСТы 7.24-90, ГОСТ 7.25-90, ИСО 25-88, ГОСТ 7.49-84, ГОСТ 7.01-90, ГОСТ 7.92-90.

7.8 Подготавливаемая на магнитных носителях эксплутационная документация должна соответствовать ГОСТ 6.104-84 "Придание юридической силы документам на машинном носителе и машинограмме, создаваемым средствами вычислительной техники".

Первый заместитель Министра путей сообщения

А.С. Мишарин

Руководитель департамента информатизации и связи

В.С. Воронин

Дирекор ВНИИАС МПС России

П.А. Козлов