Форма ведомости эксплуатационных документов. Техническая документация Ведомость эксплуатационных документов

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Постановлением Государственного комитета СССР по стандартам от 28 июня 1979 г. № 2335 срок введения установлен

с 01.07. 1980 г.

1. Настоящий стандарт устанавливает форму и правила заполнения программного документа «Ведомость эксплуатационных документов», определённого ГОСТ 19.101-77 , и обеспечивающие возможность изготовления документа машинным способом.

Стандарт полностью соответствует СТ СЭВ 2091-80.

2. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотация и содержание) является необязательным.

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

Ведомость эксплуатационных документов должна содержать следующие разделы:

• документы на программу;
• документы на составные части программы.

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

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

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

Форма ведомости приведена в обязательном приложении 1.

4. Запись документов в ведомости производят под заголовками разделов в графе «Наименование».

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

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

6. Графы ведомости заполняют следующим образом:

• в графе «Обозначение» указывают обозначение документов по ГОСТ 19.103-77 ;

в графе «Наименование» указывают полное наименование эксплуатационного документа в соответствии с наименованием, указанным на листе утверждения или титульном листе.

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


• в графе «Кол. экз.» указывают количество экземпляров данного документа;
• в графе «Местонахождение» указывают номер папки, в которой хранится документ, выполненный печатным способом.

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

Допускается приводить порядковые номера примечаний.

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

(Измененная редакция, Изм. № 1).

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

Папки в ведомости записывают после перечисления всех документов под заголовком «Перечень папок» в графе «Наименование» в порядке возрастания их порядковых номеров.

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

• графу «Обозначение» подчеркивают;
• в графе «Наименование» указывают наименование и номер папки, например, «Папка № 1»;
• в графе «Кол. экз.» указывают количество экземпляра папок данного наименования, входящих в состав одного комплекта эксплуатационных документов;
• в графе «Местонахождение» указывают, при необходимости, местонахождение папок.

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

Обозначения в примере указаны условно.

ПРИЛОЖЕНИЕ 1
Обязательное

ФОРМА ВЕДОМОСТИ ЭКСПЛУАТАЦИОННЫХ ДОКУМЕНТОВ

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

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)

Ведомость эксплуатационных документов предусмотрена стандартами двух основных систем документации , а также многими отраслевыми и корпоративными нормативными документами (см., например, ).

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

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

Для документов, разрабатываемых в соответствии с требованиями стандартов ЕСКД, шестизначный децимальный номер (например, 360269) присваивают по классификатору ЕСКД . Перед децимальным номером указывают код предприятия – разработчика (например, ШБНИ). После точки указывают порядковой номер документа в классификационной группе. В результате у ведомости эксплуатационных документов, выпущенной по стандарту ЕСКД, будет такое обозначение - ШБНИ.360269.010 ВЭ .

В стандарте установлена совершенно иная структура обозначения документа (рисунок 1).

В обозначении документа ЕСПД предусмотрен код страны [на рисунке 1 обозначен литерой А ), помещаемый перед кодом организации-разработчика [на рисунке 1 обозначен литерой В ].

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

В обозначение программного документа после регистрационного номера может быть добавлен номер редакции документа (см. два знака ХХ после дефиса на рисунке 1). И только после этого предусмотрено место для записи кода вида документа.

Стандартом установлено, что в обозначении документа код вида документа (в стандарте ЕСПД для ведомости эксплуатационных документов предусмотрен цифровой код 20) от номера редакции документа отделяет интервал. Нельзя не отметить, что номер документа от кода документа также отделяет интервал.

Учитывая все сказанное, программный документ вида ведомость эксплуатационных документов будет иметь обозначение ШБНИ.00005 - 05 20 20 .

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

На мой взгляд, использование буквенного кода вида документа в системе ЕСПД позволило бы избежать таких ошибок. В этом случае обозначение ведомости эксплуатационных документов для программных документов выглядело бы следующим образом - ШБНИ.00005 - 05 ВЭ 20 .

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

Обратим внимание на различия в стандартах систем ЕСКД и ЕСПД, касающиеся обязательности или необязательности разработки ведомости эксплуатационных документов.

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

Так как, действующий стандарт допускает разработку единого документа, в котором объединены все виды ЭД, то при разработке единого ЭД разработка ВЭ необязательна.

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

Обратим внимание ещё на одно различие между системами документации – местоположение ведомости в перечнях видов эксплуатационных документов.

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

Хотя стандартом установлено, что очередность перечисления эксплуатационных документов в этой таблице определяет последовательность их записи в ВЭ, но в стандарте ГОСТ 2.610-2006 указано, что в разделе «Документация общая» первым записывают ВЭ.

В стандарте нет прямых указаний об очередности записи тех или иных ЭД в ведомости эксплуатационных документов, однако анализ примеров заполнения ВЭ, приведенных в нём, позволяет сделать вывод, что запись программных документов в ведомости эксплуатационных документов производят в порядке возрастания кода вида документа - 1х, 2х, 3х и т.д. до 9х (рисунок 2). Подтверждение такому порядку записи эксплуатационных документов можно найти и в рекламных публикациях .

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

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

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

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

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

Единственное, в чем совпадают титульные листы документов, выполненных по стандартам ЕСКД и ЕСПД,

Наличие поля 1 (см. рисунок 3, а, б ) для отметок об учёте и хранении.

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

Примеры оформления ведомости эксплуатационных по стандартам ЕСПД (см., например, рисунок 2, а ) не содержат всех элементов оформления, предусмотренных в нормативных документах. В частности, на рисунке

2, а , нет поля для отметок о учёте и хранении 1 , строки изменений 2 по ГОСТ 19.104-78, которые показаны на рисунке 2, б .

Продолжим анализ отличий стандартов ЕСКД и ЕСПД. В стандарте ничего не сказано про оформление информационной части документа (аннотации и содержания). Для программных документов, выпускаемых по

Составление аннотации и содержания является необязательным.

По-разному в стандартах ЕСКД и ЕСПД регламентированы и названия разделов, в которых записывают

Эксплуатационные документы (таблица 1).

Таблица 1 Разделы ведомости эксплуатационных документов

Стандартами закреплено и разное оформление таблицы для записи. Если в стандарте не предусмотрено указание номера экземпляра эксплуатационного документа (см. рисунок 2, а), то стандартом

Предусмотрено указание номера экземпляра документа (рисунок 4).

1 В настоящее время существуют две системы стандартов, в которых установлены разные правила оформления

Документов одного и того же вида.

2 Использование двух систем стандартов на оформление текстовых документов приводит к:

Удвоению количества действующих стандартов;

Противоречивому регламентированию одних и тех вопросов в разных стандартах;

Потенциальному росту ошибок при оформлении документов;

Повышению затрат на оформление документов.

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

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

Создает предпосылки для неправильной идентификации вида документа. // [Электронный ресурс «Персональный сайт Захарова О.Г.»], режим доступа: предусмотрено буквенное обозначение кода вида документа.

Постановлением Государственного комитета СССР по стандартам от 11 декабря 1979 г. № 4753 срок введения установлен

с 01.01. 1981 г.

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство по техническому обслуживанию», определённого ГОСТ 19.101-77, и распространяется на тестовые и диагностические программы, используемые при обслуживаниии технических средств.

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

1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотация и содержание) является обязательным.

1.2. Руководство по техническому обслуживанию должно содержать следующие разделы:

введение;

общие указания;

требования к техническим средствам;

описание функций;

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

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

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

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

2.4. В разделе «Описание функций» указывают:

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

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

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

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

ГОСТ 19.601-78 Общие правила дублирования, учета и хранения

Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р

Постановлением Государственного комитета стандартов Совета Министров СССР от 22 февраля 1978 г. ¹ 518 срок введения установлен

с 01.01. 1980 г.

Настоящий стандарт устанавливает общие правила дублирования, обращения, учета и хранения программных документов, предусмотренных стандартами Единой системы программной документации (ЕСПД), независимо от способа их выполнения.

1. Общие требования

1.1. Все имеющиеся на предприятии подлинники, дубликаты и копии программных документов, кроме документа «Техническое задание», подлежат учету и хранению в специальных бюро (группах) в отделе технической документации (ОТД) или бюро технической документации (БТД), организуемых на предприятии в соответствии с требованиями ГОСТ 2.501-68.

1.2. Условия хранения должны обеспечивать сохранность программной документации и пригодность ее для тиражирования.

1.3. В случае утери или порчи программного документа в ОТД или БТД составляют соответствующий акт о списании по форме, соответствующей требованиям ГОСТ 2.501-68.

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

Издание (январь 2010 г.) с Изменением №1, утвержденным в сентябре 1981 г. (ИУС 11-81).

Постановлением Государственного комитета СССР по стандартам от 28 июня 1979 г. № 2335 дата введения установлена с 01.07.80

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

Стандарт полностью соответствует СТ СЭВ 2091-80 .

2. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) являются необязательным.

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

Ведомость эксплуатационных документов должна содержать следующие разделы:

документы на программу;

документы на составные части программы.

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

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

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

Форма ведомости приведена в .

(Измененная редакция, Изм. № 1).

4. Запись документов в ведомости производят под заголовками разделов в графе "Наименование".

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

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

6. Графы ведомости заполняют следующим образом:

в графе "Обозначение" указывают обозначение документов по ГОСТ 19.103-77 ;

в графе "Наименование" указывают полное наименование эксплуатационного документа в соответствии с наименованием, указанным в листе утверждения или титульном листе.

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

в графе "Кол.экз." указывают количество экземпляров данного документа;

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

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

Допускается приводить порядковые номера примечаний.

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

(Измененная редакция, Изм. № 1).

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

Папки в ведомости записывают после перечисления всех документов под заголовком "Перечень папок" в графе "Наименование" в порядке возрастания их порядковых номеров.

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

графу "Обозначение" подчеркивают;

в графе "Наименование" указывают наименование и номер папки, например "Папка №1";

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

в графе "Местонахождение" указывают, при необходимости, местонахождение папок.

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

Обозначения в примере указаны условно.

ПРИЛОЖЕНИЕ 1

Обязательное

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

Продолжение