Комплекс отраслевых руководящих методических
МИНИСТЕРСТВО ПУТЕЙ СООБЩЕНИЯ РОССИЙСКОЙ ФЕДЕРАЦИИ
КОМПЛЕКС ОТРАСЛЕВЫХ РУКОВОДЯЩИХ МЕТОДИЧЕСКИХ
МАТЕРИАЛОВ НА ИНФОРМАЦИОННЫЕ СИСТЕМЫ
НА ЖЕЛЕЗНОДОРОЖНОМ ТРАНСПОРТЕ
ТРЕБОВАНИЯ К СОСТАВУ,
СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ ДОКУМЕНТОВ
ПРИ СОЗДАНИИ ИНФОРМАЦИОННЫХ СИСТЕМ
ОРММ ИСЖТ 2.01-00
Москва, 2000 г.
АННОТАЦИЯ
Настоящий Отраслевой руководящий методический материал (ОРММ ИСЖТ
2.01-00) разработан с целью уточнения применительно к отрасли железнодорожного транспорта требований Комплекса стандартов и руководящих документов на автоматизированные системы (КС АС), Единой системы программной документации (ЕСПД), Единой системы конструкторской документации (ЕСКД), а также соответствующих международных и национальных стандартов. Он предназначен для применения в процессе документирования программного, информационного и других видов обеспечения при создании информационных систем на железнодорожном транспорте.
В связи с тем, что отдельные стандарты и руководящие документы на автоматизированные системы (КС АС), а также часть стандартов Единой системы программной документации (ЕСПД) морально устарели, в документе приведены сведения по применению на железнодорожном транспорте этих документов с учетом накопленного опыта и использования современных средств и методов разработки информационных систем.
В документе приведена укрупненная классификация информационных систем с точки зрения документирования. Разработаны рекомендации по составу документов для каждого класса систем и их компонентов (комплексов задач, задач, автоматизированных рабочих мест и пр.).
Содержание
| Общие положения | ||
| Классификация АС, функционирующих на железнодорожном транспорте | ||
| Основные принципы разработки документации | ||
| Обозначение документов | ||
| Требования к содержанию документов | ||
| Техническое задание на создание АС | ||
| Требования к оформлению технической документации на информационные системы | ||
| Приложения | ||
| Приложение А Пример оформления программного документа “Спецификация” | ||
| Приложение Б Пример оформления ведомости технорабочего проекта на комплекс задач | ||
| Приложение ВПример оформления ведомости рабочей документации на комплекс задач | ||
| Приложение Г Пример оформления ведомости эксплуатационной документации на комплекс программ | ||
| Приложение Д Пример оформления программного документа “Спецификация” |
ОБЩИЕ ПОЛОЖЕНИЯ
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.
ЖЕЛЕЗНОДОРОЖНОМ ТРАНСПОРТЕ
Автоматизированная система (АС) - система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций (ГОСТ 34.003).
Компонент автоматизированной системы - часть АС, выделенная по определенному или совокупности признаков и рассматриваемая как единое целое.
В соответствии с ГОСТ 34.003 основными компонентами автоматизированных систем с точки зрения документирования являются: организационное обеспечение, методическое обеспечение, техническое обеспечение, математическое обеспечение, программное обеспечение, информационное обеспечение, правовое обеспечение, комплекс средств автоматизации, компонент, комплектующее изделие, программное изделие, информационное средство, программно-технический комплекс, информационная база, внемашинная информационная база, машинная информационная база, автоматизированное рабочее место и пр.
В таблице 1 приведена укрупненная классификация (с точки зрения документирования) автоматизированных систем и их основных компонентов, функционирующих на железнодорожном транспорте. Определение каждого класса системы дано в разработанном ранее ОРММ АСЖТ 0.01-96 (приложение Б).
Таблица 1 - Укрупненная классификация АС на ЖТ
| Наименование класса системы | Примеры | |
| Автоматизированные системы управления | ||
| 1 Комплексные многоуровневые системы | АСУ-дороги,АС-Ш, АСУПХ и пр. | |
| 2 Системы управления предприятиями (АСУП) | АСУ-ДЕПО,АСУ-ВРЗ и пр. | |
| 3 Информационно-управляющие организационно-производственными процессами (ИУС) | АСУ СС, АСУ ГС, АСУ КП, КСАРМ сортировочной станции, КСАРМ контейнерной площадки и пр. | |
| 4 Автоматизированные системы управления технологическими процессами (АСУТП) | УВТК ДЦ, КГМ, ЛИУК, микропроцессорные ДЦ и пр. | |
| Другие автоматизированные системы | ||
| 5 Интегрированные автоматизированные системы (ИАС) | АСОУП, ИОММ, "Экспресс-2" и пр. | |
| 6 Информационно-справочные системы (ИСС) | ДИСКОР, АСНТИ и пр. | |
| 7 Автоматизированные системы обработки данных (АСОД) | ИОДВ, автоматизированные системы бухгалтерского учета, статистической отчетности и пр. | |
| 8 Системы автоматизированного проектирования (САПР) | КСАП и пр. | |
| 9 Автоматизированные системы диагностики технических и программных средств | Автоматизированные системы контроля диагностики уширения колес; системы измерения пути и пр. | |
| Компоненты автоматизированных систем | ||
| 10 Автоматизированное рабочее место (АРМ) в АС | АРМ ТВК, АРМ оператора техконторы, АРМ оператора транзитного потока файлов и пр. | |
| 11 Автоматизированное рабочее место (автономное) | АРМ экономиста, АРМ юриста и пр. | |
| 12 Аппаратно-программный комплекс (АПК) | Интеллектуальные модемы, узлы коммутации, мультиплексоры, контроллеры, драйверы, специализированного ввода информации и пр. | |
| 13 Системы сбора и передачи информации (ССПИ) | ЕСПД, ДИСКЛ, ДИСКЕ, системы автоматического считывания, концентраторы информации и пр. | |
| 14 Общесистемное программное обеспечение АС | Системы обработки файлов, системы передачи данных, программное обеспечение локальной сети и пр. | |
| 15а Информационная база (банк) данных в АС (статическая) | Электронная картотека техниче-ских паспортов грузовых вагонов и пр. | |
| 15б Информационная база данных в АС (динамическая) | Модели перевозочного процесса (поездная модель, вагонная модель, отправочная модель, контейнерная модель и пр.) | |
| 16 Комплекс задач (задача) | АИЛ,КОО-4 и пр. | |
Таблица 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 - Перечень документов, который используется при
Таблица 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типо-вая | нетипо-вая | ||||||
 ЭП | Ведомость эскизного проекта | ЭП | ГОСТ 2.106 | 1-5 | + | + | |||
| Пояснительная записка к эскизному проекту | П1 | РД 50-34.698 | 1-5 | + | + | ||||
| Пилот-проект | Ведомость пилот-проекта. | П-П | ГОСТ 2.106 | 2-5 | + | + | + | + | |
| Пояснительная записка к пилот-проекту | П-П2 | РД 50-34.698 и настоящий документ | 2-13 | + | + | + | + | При необхо- димости включает отдельные разделы документов ТП | |
| ТП | Ведомость технического проекта | ТП | ГОСТ 2.106 | 2-13, 15-16 | + | + | + | + |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
 ТП | Пояснительная записка к техническому проекту | П2 | РД 50-34.698 | 2-13, 15-16 | + | + | Включает план меро- приятий по подготовке объекта к вводу систе-мы в эксплу-атацию | ||
| Описание информацион-ной технологии системы | ПТ | Настоящий документ | 1-5 | + | + | ||||
| Описание автоматизи-руемых функций | П3 | РД 50-34.698 | 2-8 | Разрабаты-вается для системы в целом | |||||
| Описание постановки общесистемного проектного решения по базе данных | П12 | Настоящий документ | 2-7, 10,11, 13, 15 | Разрабаты-вается для системы в целом и частного ТЗ на БД |
Продолжение таблицы 4
 Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
| ТП | Описание постановки задачи (комплекса задач) | П4 | РД 50-34.698 и настоящий документ | 10-11,16 | + | + | + | + | Для подсистем (комплексов задач, задачи, АРМ) |
| Описание информацион-ного обеспечения | П5 | РД 50-34.698 | 2-10, 15 | + | + | + | + | ||
| Описание системы классификации и кодирования | П7 | РД 50-34.698 | 2-11,15 | + | + | Для несложных АС и отдельных задач может включаться в документ П5 |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
 ТП | Перечень входных сигналов и данных | В1 | РД 50-34.698 | 1-10, 12 -13 | |||||
| Перечень выходных сигналов (документов) | В2 | РД 50-34.698 | |||||||
| Описание комплекса технических средств | П9 | РД 50-34.698 | 2-10 | + | |||||
| Описание программного обеспечения | ПА | РД 50-34.698 | 2-9,12-15 | + | |||||
| Описание алгоритма (проектной процедуры) | ПБ | РД 50-34.698 | 10-11,16 | + | + | + | + | Допускается включать в П2, П4 | |
| Описание организацион-ной структуры | ПВ | РД 50-34.698 | 1-7,10-11 | Разрабаты-вается для системы в целом |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
| ТП, РД | Чертеж формы документа (видео-кадра) | С9+ | УСД, Р50-77 | 2-13, 16 | |||||
| Ведомость технорабочего проекта | ТРП | ГОСТ 2.106 | 1- 16 | + | + | + | + | ||
| Описание локальной вычислительной сети ПЭВМ | П10 | Настоящий документ | 2-3, 5-6 | Разрабаты-вается для АСУП, КСАРМ | |||||
| РД | Ведомость рабочей документации | РД+ | ГОСТ 2.106 | 2-16 | + | + | |||
| Каталог базы данных | В7+ | РД 50-34.698 | 1-7, 10-11, 15-16 | Для небольших БД включается в И3 |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
 РД | Методика (технология) автоматизи-рованного проектирования | И1 | РД 50-34.698 | + | + | + | + | Для САПР | |
| Состав выходных данных (сообщений) | В8 | РД 50-34.698 | 2-10 | Для АРМ и несложных АС может включаться в документ П5 | |||||
| РД | Руководство пользователя | И3+ | РД 50-34.698 и настоящий документ | 2-16 | + | + | + | + | |
| Инструкция по формированию и ведению базы данных (набора данных) | И4+ | РД 50-34.698 | 2-11, 15 | + | + | + | + | Для АС, имеющих отн. неболь-шую БД, может офор-мляться как раздел И3 | |
| Руководство администратора БД | И5+ | Данный документ | + | + | + | + |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
| РД | Руководство администратора системы | И6+ | Данный документ | 1-9 | |||||
| Инструкция по эксплуатации КТС* | ИЭ+ | РД 50-34.698 | 9, 12 | + | + | ||||
| Описание техно-логического процесса обработки дан-ных, включая телеобработку | ПГ+ | РД 50-34.698 | 1-7,10- 11,15-16 | + | + | ||||
| Общее описание системы | ПД | РД 50-34.698 | 1-9, 12-13 | ||||||
| РД | Описание регулярных запросов к БД | ПЗ | Настоящий документ | 1-11, 15 | |||||
| Схема соединений внешних проводок | С4+ | РД 50-34.698 | 2-5, 12-13 | Оформляется в виде таблицы |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типовая | нетипо-вая | ||||||
 РД | Схема подклю-чения внешних проводок | С5+ | РД 50-34.698 | 2-5, 12-13 | Оформляет-ся в виде таблицы | ||||
| Таблица соединений и подключений | С6+ | РД 50-34.698 | 2-5, 12-13 | Оформляет-ся в виде таблицы | |||||
| Программа и методика испытаний (компонентов, средств автоматизации, подсистем, систем) | ПМ | РД 50-34.698 и настоящий документ | 1-16 | + | + | Для типовых систем и компонентов дорожного и линейного уровня | |||
| Ведомость держателей подлинников | ДП | ГОСТ 2.112 | 2-16 | 0- | |||||
| Паспорт | ПС+ | РД 50-34.698 и настоящий документ | 1-16 | + | + | + | + | ||
| Все стадии | Таблицы | ТБ | - | 1-16 | |||||
| Расчеты | РР | - | 1-16 | ||||||
| Документы | Д | - | 1-16 |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типо-вая | нетипо-вая | ||||||
 | ПРОГРАММНАЯ ДОКУМЕНТАЦИЯ | ||||||||
| Техническое задание на программное средство | - | ГОСТ 19.208 | 11,14-16 | ||||||
| ТП | Пояснительная записка | ГОСТ 19.404 | 11,14-16 | + | + | Обязателен при отсутствии ТП на систему | |||
| РД | Спецификация | - | ГОСТ 19.202 | 2-16 | + | + | Для програм- мных средств | ||
| Текст программы | ГОСТ 19.401 | 2-16 | |||||||
| Описание программы (комплекса программ) | ГОСТ 19.402-78* | 2-16 | + | + |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствии с таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типо-вая | нетипо-вая | ||||||
 РД | Описание применения | ГОСТ 19.502-78* и настоящий документ | 11,14-16 | Обязателен при отсутст-вии ТП | |||||
| Руководство системного программиста | 32+ | ГОСТ 19.503-79* | 2-10, 14-16 | + | - | - | Может объединять-ся с другими. до-кументами | ||
| Руководство программиста | 33+ | ГОСТ 19.504-79* и настоящий документ | 2-10, 14-16 | + | - | - | - “ - | ||
| Руководство по инсталляции | И7+ | Настоящий документ | 1-7,10-11 | ||||||
| Руководство оператора | 34+ | ГОСТ 19.505-79* и настоящий документ | 2--10, 14-16 | + | + | - | - | - “ - | |
| Программа и методика испытаний | ГОСТ 19.301-79* | 14-16 |
Продолжение таблицы 4
| Стадии создания | Наименование документа | Код доку-мента и признак экспл.док. | Содержание (ГОСТ, РД и другие нормативные документы) | Класс АС в соответствиис таблицей 1 данного документа | АС и ее части на базе | Примечание | |||
| Mainframe + ПЭВМ | ПЭВМ | ||||||||
| типовая | нетипо-вая | типо-вая | нетипо-вая | ||||||
 РД | Руководство по организации сопровожде-ния | ОРММ ИСЖТ | 1-16 | ||||||
| Руководство оперативного пользователя | 91+ | Настоящий документ | 1-16 | - | - | Объединяет 32, 33, 34,35 | |||
| П Р И М Е Ч А Н И Я 1 В таблице 4 приняты следующие обозначения: ЭП – эскизный проект. ТП – технический проект. РД – рабочая документация. 2 Знак "+" в графах 6-9 означает обязательность разработки документа. Знак "-" - разработка документа необязательна, Знак "0" – необходимость разработки документа и включения его в комплект устанавливается в техническом задании на создание АС и ее компонентов. 3 В системах с большими объемами ввода данных может быть разработано "Руководство оператора". 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.1.1 Требования к содержанию документов технического и рабочего проектов установлены в РД 50-34.698, соответствующими стандартами ЕСПД, ЕСКД, а также рекомендациями международных и национальных стандартов. Некоторые уточнения по наиболее важным из них приведены в данном ОРММ ИСЖТ.
5.1.2 В зависимости от объема проектирования (система, комплекс задач, АРМ) разработчик самостоятельно определяет содержание каждого документа.
5.1.3 Содержание отчетов по ГОСТ 7.32, разрабатываемых на предпроектных стадиях ("Формирование требований к АС" и "Разработка концепции АС") по набору разделов представлено в РД-34.698 (приложение1).
5.2 Требования к содержанию документов по общесистемным решениям
5.2.1 В е д о м о с т ь п р о е к т о в
Ведомость проектов содержит перечни всех документов, разработанных на определенной стадии.
Документ следует выполнять по ГОСТ 2.106.
Документ "Ведомость проекта" составляется при разработке технического, рабочего (технорабочего) проектов и может являться основным при предъявлении комплекта документов на АС и их компонентов для утверждения (подписания).
В ведомость документов технического, рабочего (технорабочего) проектов следует включать наименования и обозначения всех вновь разработанных для данного проекта документов и (или) заимствованных из других проектов, ранее разработанных АС или их частей и компонентов.
В случае, когда части АС и их компоненты разрабатываются как самостоятельные темы, в ведомости проекта на систему в соответствующие разделы включаются ведомости технического, рабочего или технорабочего проектов, компонентов, разрабатываемых для данной системы.
Ведомость технического проекта на систему включает разделы:
- документация по общесистемным решениям;
- документация решений по организационному обеспечению;
- документация решений по техническому обеспечению;
- документация решений по информационному обеспечению;
- документация решений по программному обеспечению;
- документация решений по математическому обеспечению.
В ведомость технического или технорабочего проектов, разрабатываемых с применением в них в качестве общесистемного проектного решения пакетов прикладных программ (систем телеобработки, систем управления базами данных, программного обеспечения сетей ЭВМ и др.), в раздел "Документация решений по программному обеспечению" включают спецификации используемых ППП и программ привязки.
Пример оформления ведомости технического проекта приведен в приложении А, ведомости документов технорабочего проекта - в приложении Б, ведомости рабочей документации - в приложении В.
5.2.2 О п и с а н и е и н ф о р м а ц и о н н о й т е х н о л о г и и с и с т е м ы
Документ предназначен для описания информационной технологии для комплексных многоуровневых и интегрированных информационных систем и включает следующие разделы:
1) Общие положения:
- наименование системы и ее назначение;
- основные компоненты системы;
- этапы создания системы и функциональный состав задач каждого этапа.
2) Состав сообщений
Приводятся виды сообщения на всех уровнях функционирования системы.
3) Технология подготовки, формирования и передачи информации (сообщений, документов, сигналов и пр.)
Приводится информация об основных объектах системы, где осуществляется зарождение информации, ее формирование, контроль, прием и передача. Описывается технология этого процесса.
4) Основные базы данных системы и их состав
Приводятся базы данных (сервера) как системы в целом, так и входящих в нее компонентов (подсистем, АРМ и пр.). Описывается их организация и состав, а также администрирование.
5) Принципы логического контроля и синхронизации баз данных
Описываются принципы контроля (форматный, логический)