Оформляем
«Ведомость эксплуатационных
документов»
Ведомость эксплуатационных документов предусмотрена стандартами двух
основных систем документации [1, 2], а также многими отраслевыми и
корпоративными нормативными документами (см., например,
[3]).
Стандарты ЕСКД разработаны в докомпьютерную эру, применительно к
материальным объектам - изделиям, когда ни о каком программном обеспечении не
было и речи. В свою очередь, стандарты ЕСПД выпущены для нематериальных объектов
- программного обеспечения, без учета ограничений, наложенных стандартами
системы ЕСКД. Поэтому при совместном применении стандартов ЕСКД и ЕСПД для
изделий, представляющих собою совокупность оборудования («железа»,
Hardware)
и программного обеспечения («софта»,
Software),
возникает ряд неудобств.
Прежде
всего, в стандартах этих систем применены разные принципы обозначения
документов.
Для
документов, разрабатываемых в соответствии с требованиями стандартов ЕСКД,
шестизначный децимальный номер (например, 360269) присваивают по классификатору
ЕСКД [4]. Перед децимальным номером указывают код предприятия – разработчика
(например, ШБНИ). После точки указывают порядковой номер документа в
классификационной группе. В результате у ведомости эксплуатационных документов,
выпущенной по стандарту ЕСКД, будет такое обозначение - ШБНИ.360269.010
ВЭ.
В
стандарте [5] установлена совершенно иная структура обозначения документа
(рисунок 1).
|
Рисунок 1
Структура обозначения программных документов по
[5] |
В
обозначении документа ЕСПД предусмотрен код страны [на рисунке 1 обозначен
литерой А), помещаемый перед кодом
организации-разработчика [на рисунке 1 обозначен литерой В].
Как
сказал К. Прутков, нет ничего более постоянного, чем временное. Поэтому
предусмотренное в стандарте [5] временное разрешение присваивать
регистрационный номер в порядке возрастания от 00001 до 99999 действует до сих
пор, а классификатор программ, аналогичный классификатору ЕСКД, так и не
утвержден.
В
обозначение программного документа после регистрационного номера может быть
добавлен номер редакции документа (см. два знака ХХ после дефиса на рисунке 1).
И только после этого предусмотрено место для записи кода вида документа.
Стандартом
[5] установлено, что в обозначении документа код вида документа (в стандарте
ЕСПД для ведомости эксплуатационных документов предусмотрен цифровой код 20) от
номера редакции документа отделяет интервал. Нельзя не отметить, что номер
документа от кода документа также отделяет интервал. Учитывая все сказанное,
программный документ вида ведомость эксплуатационных документов будет иметь
обозначение ШБНИ.00005 - 05 20 20[1].
Все сказанное создает возможность неправильной идентификации документа по его
обозначению.
На
мой взгляд, использование буквенного кода вида документа в системе ЕСПД
позволило бы избежать таких ошибок, а обозначение ведомости эксплуатационных
документов для программных документов выглядело бы следующим образом -
ШБНИ.00005 - 05 ВЭ 20[2].
Использование
аббревиатуры ВЭ можно встретить в текстах, описывающих разработку программной
документации [6].
Обратим внимание на различия в стандартах систем ЕСКД и ЕСПД, касающиеся
обязательности или необязательности разработки ведомости эксплуатационных
документов.
В
стандарте [1] установлено, что разработка ВЭ обязательна только в том случае,
когда для изделия выпускают два или более самостоятельных эксплуатационных
документа. Так как, действующий стандарт [1] допускает разработку единого
документа, в котором объединены все виды ЭД, то при разработке единого ЭД
разработка ВЭ необязательна.
В
то же время стандарт [2] не допускает объединять ведомость эксплуатационных
документов и формуляр с другими эксплуатационными документами. Поэтому для
программных документов приходится практически всегда разрабатывать ведомость
эксплуатационных документов.
Обратим
внимание ещё на одно различие между системами документации – местоположение
ведомости в перечнях видов эксплуатационных документов.
В
стандарте [1], где установлена номенклатура эксплуатационных документов,
ведомость эксплуатационных документов размещена в последней строке таблицы
2.
Хотя
стандартом [1] установлено, что очередность перечисления эксплуатационных
документов в этой таблице определяет последовательность их записи в ВЭ, но в
стандарте ГОСТ 2.610-2006 указано, что в разделе «Документация общая» первым
записывают ВЭ.
В
стандарте [2] нет прямых указаний об очередности записи тех или иных ЭД в
ведомости эксплуатационных документов, однако анализ примеров заполнения ВЭ,
приведенных в нём, позволяет сделать вывод, что запись программных документов в
ведомости эксплуатационных документов производят в порядке возрастания кода
вида документа - 1х, 2х, 3х и т.д.
до 9х (рисунок 2). Подтверждение
такому порядку записи эксплуатационных документов можно найти и в рекламных
публикациях [6].
Необходимо
отметить, что в стандарте [2] прямо указано - ведомость эксплуатационных
документов не должна входить в раздел «Документы на
программу».
|
|
Рисунок 2 Лист
ведомости эксплуатационных документов по
[2] (а), и лист внесения
изменений (б)
1
– поле
для отметок об учете и хранении,
2 – строка изменений |
Рассмотрим
другие различия в оформлении данного документа по стандартам ЕСКД и ЕСПД,
которые необходимо учитывать при оформлении ведомости эксплуатационных
документов.
Согласно
[1] ВЭ по ЕСКД выполняют по правилам, предусмотренным стандартом [8]. Эти
правила отличаются от правил, которые следует соблюдать при разработке
ведомости эксплуатационных документов, выпускаемой по стандартам ЕСПД
[9].
Следует
отметить, что и титульные листы ведомостей эксплуатационных документов,
разработанных по правилам, установленными стандартами [10] и [11] существенно
отличаются друг от друга (рисунок 3).
а) |
б) |
|
|
Рисунок 3
Титульные листы документов, оформленных по [10] (a) и [11] (б) 1 – поле для
отметок об учёте и
хранении |
Самое
важное отличие состоит в том, что программные документы выполняют без рамок, в
отличие от любых документов по [1, 12].
Единственное,
в чем совпадают титульные листы документов, выполненных по стандартам ЕСКД и
ЕСПД, - наличие поля 1 (см.
рисунок
3, а, б) для отметок об учёте и
хранении.
В
примере оформления, приведенном в стандарте [11], оно расположено на титульном
листе произвольно (см. рисунок 3, б), хотя должно быть расположено в
левом нижнем углу страницы.
Примеры
оформления ведомости эксплуатационных по стандартам ЕСПД (см., например,
рисунок 2, а) не содержат всех
элементов оформления, предусмотренных в нормативных документах. В частности, на
рисунке 2, а, нет поля для отметок
о учёте и хранении 1, строки
изменений 2 по ГОСТ 19.104-78,
которые показаны на рисунке 2, б.
Продолжим
анализ отличий стандартов ЕСКД и ЕСПД. В стандарте [1] ничего не сказано про
оформление информационной части документа (аннотации и содержания). Для
программных документов, выпускаемых по [2], составление аннотации и содержания
является необязательным.
По-разному в стандартах ЕСКД и ЕСПД регламентированы и названия разделов,
в которых записывают эксплуатационные документы (таблица 1).
Таблица
1 Разделы ведомости эксплуатационных документов
Разделы
ведомости по [1] |
Разделы
ведомости по [2] |
-
общая документация (на изделие в целом); |
-
документы на программу; |
-
документация на составные части изделия, включая покупные
изделия; |
-
документы на составные части программы. |
-
перечень папок и футляров, в которые уложена
документация. |
|
Стандартами [1, 2] закреплено и разное оформление таблицы для записи.
Если в стандарте [2] не предусмотрено указание номера экземпляра
эксплуатационного документа (см. рисунок 2, а), то стандартом [1] предусмотрено
указание номера экземпляра документа
(рисунок
4).
|
Рисунок 4
Форма таблицы для записи эксплуатационных документов по
[1] |
Выводы.
1
В настоящее время существуют две системы стандартов, в которых установлены
разные правила оформления
документа
одного и того же вида – ведомости эксплуатационных
документов.
2
Использование двух систем стандартов на оформление текстовых документов приводит
к:
-
удвоению количества действующих стандартов;
-
противоречивому регламентированию одних и тех вопросов в разных
стандартах;
-
потенциальному росту ошибок при оформлении документов;
-
повышению затрат на оформление документов.
3
Правила оформления документов в стандартах ЕСКД и ЕСТП изложены с разной
степенью полноты, что зачастую требует анализа всех стандартов, входящих в эти
системы.
4
Действующая система обозначений программных документов, использующая цифровой
код вида документа создает предпосылки для неправильной идентификации вида
документа.
Литература
1.
ГОСТ 2.601-95. ЕСКД. Эксплуатационные документы.
2.
ГОСТ 19.507-79. ЕСПД. Ведомость эксплуатационных
документов
3.
A.B.00001-01
20 01
(Ведомость эксплуатационных документов).
4.
ОК
012-93.
Общероссийский классификатор изделий и конструкторских
документов.
5
ГОСТ 19.103-77. ЕСПД. Обозначение программ и программных
документов.
6
Ведомость
эксплуатационных документов
// [Электронный ресурс], режим доступа:https://www.swrit.ru/vedomost-ekspluatacionnyh-dokumentov.html
7.
ГОСТ 19.101-77. ЕСПД. Виды программ и программных
документов.
8
ГОСТ
2.105-95 ЕСКД.
Общие требования к текстовым документам.
9
ГОСТ 19.105-78. ЕСПД. Общие требования к программным
документам.
10
Титульный
лист
// [Электронный ресурс «Персональный сайт Захарова О.Г.»], режим доступа:
https://olgezaharov.narod.ru/2015/writer_author/titul_page.htm
11
ГОСТ 19.104-78. ЕСПД. Основные надписи.
12
ГОСТ 2.104-2006. Основные надписи
13
ГОСТ 19.604-78. Правила внесения изменений в программные документы, выполненные
печатным способом
[1] Сравните
с приведенным выше обозначением ведомости эксплуатационных документов,
выпущенной по стандартам ЕСКД, -
ШБНИ.360269.010
ВЭ.
[2] Использование
буквенного кода вида документа, позволило бы использовать аббревиатуру ВЭ, как
это сделано несколькими строчками выше. Однако, чтобы не произошло путаницы
между документами разных систем, в данной работе приходится использовать полное
название документа. Обозначение этого документа в тексте числом 20 невозможно по
вполне понятным причинам.
Кстати,
в стандартах системы ГОСТ
34
предусмотрено буквенное обозначение кода вида документа.
Сайт «Лексикон релейщика»:::Правка
:::12.12.2024_14-20:::