вторник, 1 марта 2016 г.

Код документа по ГОСТу: небольшой ликбез

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



Зачем нужны обозначения документов?

Нас иногда спрашивают, как правильно присвоить документу код, шифр, номер и т. п. ? Скажем сразу, что это не великая наука. Но, во-первых, не код и не шифр, а обозначение, во всяком случае, если мы намерены соблюдать требования ГОСТ 19 или ГОСТ 34. Во-вторых, давайте сначала разберемся, в чем смысл обозначений документов.
В советскую эпоху, в еще машинописно-бумажные времена обозначения документов служили для ведения архива. Представьте себе крупную организацию, которая заказывает или собственными силами разрабатывает много программ или автоматизированных систем. Технической документации у нее тоже накапливается много. Чтобы ориентироваться в ней, помимо всего прочего необходимо снабдить каждый документ уникальным идентификатором. В качестве такового отечественные стандарты предлагают использовать обозначение, формируемое по определенным регулярным правилам. О них и пойдет речь в данной статье ниже.
Обозначения документов нужны не прокурору, не Ростехрегулированию, не разработчику программы или системы, а, в первую очередь, Заказчику. Если ваш заказчик требует во что бы то ни стало снабдить созданные для него документы «кодом по госту», можно в ответ поинтересоваться, ведет ли он архив технической документации. К сожалению, в большинстве случаев ответ будет отрицательным. Если же заказчик располагает таким архивом, то, скорее всего, электронным, а не бумажным. В электронных архивах уникальные идентификаторы обычно присваиваются документам автоматически.
Таким образом, присвоение документам гостированных обозначений сегодня в значительной мере лишено смысла и представляет собой «магический ритуал». Как быть, если заказчик все-таки настаивает на его исполнении? Разумеется, исполнять.

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

Структура обозначения системного документа в соответствии с ГОСТ 34.201-89 показана ниже. Расшифровка частей обозначения приведена в таблице.
A.B.CCC.DD.EE.F-G.M
Часть обозначенияЗначение
Aкод организации-разработчика системы. В ГОСТ 34.201-89 сказано: «Код организации-разработчика присваивают в соответствии с общесоюзным классификатором предприятий, учреждений и организаций (ОКПО) или по правилам, установленным отраслевыми НТД». По известным причинам общесоюзного классификатора сегодня с нами нет, зато существует Общероссийский классификатор предприятий и организаций (ОКПО). Код ОКПО входит в состав официальных реквизитов организации, и его должны знать у вас в бухгалтерии. Если вам очень не хочется звонить в бухгалтерию, попробуйте найти свою компанию в онлайновом справочнике, но имейте в виду, что надпись на табличке у дверей офиса не всегда совпадает с названием юридического лица.
Bкод классификационной характеристики типа системы или ее части. Согласно ГОСТ 34.201-89, этот код следует выбирать из общесоюзного классификатора продукции, на смену которому сегодня пришел Общероссийский классификатор продукции (ОКП). Он многократно опубликован в Интернете, вы без труда найдете его по приведенной здесь ссылке или с помощью поисковика. В этом классификаторе собрана вся возможная продукция от шагающих экскаваторов до булавок. Раздел классификатора, посвященный автоматизированным системам, начинается строкой 425000 Программно-технические комплексы для автоматизированных систем. Возможно, в классификаторе имеются другие строки, которые вам больше подходят по специфике системы. Попробуйте найти их обычной функцией поиска по тексту страницы. В качестве альтенативы ОКП стандарт предлагает использовать общесоюзный классификатор подсистем и комплексов задач АСУ (ОКПКЗ). Насколько нам известно, он был отменен, но ничем другим не заменен, таким образом, эта ссылка делается достоянием истории
CCCрегистрационный номер автоматизированной системы или ее части. Предполагается, что разработчик организовал у себя учет выпускаемых автоматизированных систем и присваивает им регистрационные номера. Если у вас в компании это не принято, значит, вы не можете полноценно соблюдать требования КСАС. Начните новую жизнь, заведите журнал регистрации выпущенных систем. Нумерация систем ведется по каждому типу (т. е. коду классификационной характеристики, см. выше) систем отдельно. Как быть организации, которая ухитрилась выпустить 1000 однотипных автоматизированных систем, стандарт не говорит
DDкод документа (точнее, типа документа) по ГОСТ 34.201-89. Например, код руководства пользователя — И3 (и-три), а код программы и методики испытаний —ПМ.
EEномер документа одного наименования. Допустим, у вас в комплекте документации три технологические инструкции для трех разных функциональных ролей. В этом случае у них будут номера 01, 02 и 03. Правила назначения этих номеров (по дате выпуска документа, по названиям в алфавитном порядке или как-нибудь иначе) не уточняются. Главное, чтобы номера шли последовательно с единицы. Если в комплект входит только один документ некоторого типа, например, одна пояснительная записка к техническому проекту, номер не присваивают, а соответствующая позиция в обозначении пропускается
Fномер редакции документа. Речь идет о тех редакциях, которые вы официально передаете заказчику, а он их официально принимает и утверждает. Если в процессе рецензирования и согласования документа заказчик многократно присылал вам замечания, а вы ему в ответ исправленный файл, о новых редакциях документа речь не идет, это рабочие материалы и только. Новая редакция возникает в том случае, если заказчик утверждает новый вариант документа, сохраняя при этом предыдущий, и в принципе в каких-нибудь ситуациях может пользоваться ими обоими. В противном случае устаревший вариант можно аннулировать и забыть о нем навсегда. Номера присваивают редакциям, начиная со второй. В первой редакции соответствующая позиция в обозначении пропускается
Gномер части документа. Документ можно физически разделить на несколько частей. Обычно так поступают, чтобы документ было удобнее читать или переплетать. Если документ не разделен на части, номер не присваивают, а соответствующая позиция в обозначении пропускается
Mв 1989 году электронные документы еще были явлением новым и непривычным. Типичный документ представлял собой лист или стопку листов бумаги с согласующими и утверждающими подписями. Тот факт, что дискета или магнитная лента с записанным на ней текстом тоже может быть документом, требовал отдельного осмысления. Поэтому к обозначению таких документов добавляли буквуM. Как ни странно, эта практика и теперь не лишена оснований, поскольку у нас в стране в официальном документообороте фигурируют именно бумажные документы с оригинальными подписями компетентных лиц и «мокрыми» печатями организаций. Поэтому, например, технологическая инструкция, за несоблюдение которой сотрудника можно официально наказать, должна быть выполнена именно в таком виде. Но если заказчик требует от нас, допустим, текст программы (документ, предусмотренный ЕСПД), мы все-таки можем предоставить ему не грузовик листингов, а компакт-диск. Обозначение такого документа должно завершаться буквойM, которую отделяют от предыдущей части точкой (а не дефисом!)
В качестве примера присвоим обозначение технологической инструкции для пользователя этого сайта. Сайт будем рассматривать в качестве автоматизированной системы, которую мы разработали сами для себя, причем это был наш первый опыт разработки систем такого типа. Пользователем будем считать сотрудника «Мегасайт», который публикует на сайте статьи. Условимся также, что ответственный за публикацию — не единственная функциональная роль. Еще у нас есть ответственный за размещение рекламных баннеров, для которого написана своя технологическая инструкция. Действует первая редакция технологической инструкции, документ не разделен на части, существует в виде бумажного оригинала с подписями и печатями. С учетом перечисленных обстоятельств обозначение получается таким:
63755082.425750.001.И2.01, где
63755082 — код ООО «Мегасайт» согласно ОКПО.
425750 — код строки Программно-технические комплексы для автоматизации обработки информации в торговле, материально-техническом обеспечении согласно ОКП. Автор статьи полистал ОКП, подумал и решил, что данная характеристика подходит нашему сайту лучше всех остальных там предлагаемых. Возможно, он заблуждается.
001 — регистрационный номер автоматизированной системы этого типа в нашем внутреннем учете (давайте считать, что мы его ведем).
И2 — код технологической инструкции по ГОСТ 34.201-89.
01 — номер технологической инструкции в комплекте технической документации на сайт. Напомним, что есть еще одна, для менеджера по рекламным баннерам, у нее номер 02.

Обозначение технического задания на автоматизированную систему

В п. 3.2 ГОСТ 34.602-89 есть фраза, в которой упоминается некий код ТЗ: «Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, в верхней части листа (над текстом, посередине) после обозначения кода ТЗ на АС».Вместе с тем, в ГОСТ 34.201-89 приведены коды документов, разрабатываемых на стадиях, начиная с эскизного проекта, но кода для ТЗ там нет, что несколько сбивает с толку.
При формировании кода ТЗ на АС можно принять во внимание п. 3.5. ГОСТ 34.602-89, в котором сказано: «При необходимости на титульном листе ТЗ на АС допускается помещать установленные в отрасли коды, например: гриф секретности, код работы, регистрационный номер ТЗ и др.», и присвоить код произвольно, сославшись на то, что так принято в отрасли или определено НТД конкретного предприятия. Кроме того, можно вспомнить, что по ГОСТ 24.101-80 у технического задания был код 2А, и присвоить документу обозначение по схеме, описанной выше. Но в общем это все уже напоминает схоластический подсчет количества чертей на кончике иглы.

Обозначения документов по программам

Структура обозначения программного документа в соответствии с ГОСТ 19.103-77 показана ниже. Расшифровка частей обозначения приведена в таблице. Номер редакции, номер документа и номер части документа образуются так же, как для системных документов (в исторической перспективе наоборот, но мы просим читателя простить нам этот анахронизм).
A.B.CCCCC-DD EE FF-G
Часть обозначенияЗначение
Aкод страны. В наше время разумно указывать двухбуквенный код в соответствии со стандартом ISO 3166-1RU для России, KZ для Казахстана и т. д.
Bкод организации-разработчика. По аналогии с системными документами можно указывать код ОКПО
CCCCCрегистрационный номер программы. Согласно ГОСТ 19.103-77, он должен присваиваться «в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке». Как соблюдать это требование сегодня, нам неизвестно. Обратите внимание на год утверждения стандарта: 1977. Многое изменилось с тех пор в нашей жизни
DDномер редакции документа
EEкод вида документа в соответствии с ГОСТ 19.101-77
FFномер документа данного вида
Gномер части документа
Начальная часть обозначения, A.B.CCCCC-DD, служит обозначением самой программы и одновременно главного связанного с ней документа, спецификации.

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

Любую программу или автоматизированную систему можно рассматривать как изделие и документировать на общих основаниях, руководствуясь ЕСКД (ГОСТ 2). Этой же серией стандартов следует пользоваться при документировании технических средств, например серверов, рабочих станций, всевозможных специализированных устройств и т. п. Правила присвоения обозначений конструкторским документам устанавливает ГОСТ 2.201-80. Здесь мы воздержимся от пересказа этого документа, но не сомневаемся, что теперь читатель без труда найдет и освоит его.

Обозначения листов утверждения

Если документ снабжен листом утверждения, у последнего должно быть свое обозначение. Оно формируется по элементарному правилу: к обозначению документа следует добавить шифр ЛУ, отделив его дефисом, например: 63755082.425750.001.И2.01-ЛУ.

О пользе обозначений со сдержанным оптимизмом

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

За материалы спасибо PhiliSoft

Комментариев нет:

Отправить комментарий

Вы можете добавить свой комментарий...