Вступить в Клуб Войти
Введите логин
Введите пароль
напомнить пароль

Игорь Мялковский, заместитель генерального директора по автоматизации, Тринити: «Программа без «доки» = борьба без правил»

10.07.2011

10 Июля 2011 года

Игорь Мялковский, заместитель генерального директора по автоматизации, Тринити: «Программа без «доки» = борьба без правил»


Когда не знают, что делать дальше, открывают документацию

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

Что такое ОКП?

Общероссийский классификатор продукции (далее ОКП) входит в состав Единой системы классификации и кодирования технико-экономической и социальной информации (ЕСКК) Российской Федерации.

ОКП разработан и введен в действие на территории Российской Федерации взамен Общесоюзного классификатора промышленной и сельскохозяйственной продукции (ОКПСП). Он явно «лучше»!

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

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

Формат обозначения документа-описания программного продукта в оригинале ГОСТ 19.103-77:

 Общая часть обозначения программы

 и программных документов на нее - A.B.XXXXX
 Номер редакции документа - XX      
 Код вида документа - XX                             
 Номер документа данного вида - XX                    
 Номер части документа - X                                 
 
Замечательный ГОСТ! Все то же. Замечательно, кроме одного. Народ по ГОСТУ не пробовал давно: не хватает количества позиций! И «народ хочет разобраться».     
 
Можно использовать более простой вариант, подобно, но лучше чуть проще: изменить количество знаков, соответствующих некоторым символам обозначения. И в обозначении формата это количество можно проигнорировать, как всегда, без ущерба для закона от 27.12.2002 №184-ФЗ:

A.B.C-D E F-H

Расшифровка обозначения в таблице 1.

Номер редакции, номер документа и номер части документа образуются так же, как для документов на систему. Исторически, как подтверждают многие другие авторы и практики применения ГОСТа, было наоборот: сначала старались документировать программы, потому что их изначально было больше, чем систем.

A    Код страны

Это совсем простой код по ISO 3166-1: RU для России, KZ для Казахстана и т.д. Можно буквы копировать с автомобильных номеров!

B    Код организации-разработчика

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

C = ХХХХХ    Регистрационный номер программы

Почему-то ГОСТом определено пять знаковых позиций.
Согласно ГОСТ 19.103-77, он должен присваиваться «в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке». Как соблюдать это требование сегодня, неизвестно. Очевидно, в 1977 г. в этом классификаторе хватало числа порядка 99999. Сколько стало программ теперь, вряд ли кто знает. Но наверняка больше ста тысяч. Потому и число позиций С согласно ГОСТ давно не имеет значения. Столько, сколько нужно! ГОСТ-то добровольный. Пока. До времени. Пока любимые чиновники гайки в очередной раз не закрутят.

D = ХХ    Номер редакции/версии документа

Позиций справедливо две. Сложно представить себе организацию, в которой более 99 раз утверждают один документ. Хотя для гос., бюджетных и проч.… Кто ж их поймет? С подверсиями можно поступать так же, как в формате документов для систем: D.d. Помним, что номер версии используют в обозначении, начиная со второй. Помним также, что в обозначении документа номера подверсий для лучшего соответствия ГОСТ использовать не рекомендуется: они в достаточном количестве есть после «Красивого названия документа».

E = ХХ    Код вида документа

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

F = XX    Номер документа данного вида по порядку в организации

G    Номер части документа, если документ разбит на части

Единственный знак, который справедливо от основной части отделяется дефисом.

Таблица 1

Часть обозначения A.B.C-D используется для самого листинга программы и для спецификации.

Получаем для ПО WEB-конфигуратора, разработанного в России (А = RU), в компании «Тринити» B = 7802114622, зарегистрированного в ОКП под номером, допустим, C = 123 456 789, дальше все по таблице произвольно, для четвертой части (D = 02.01, E = 03, F = 04):

RU. 7802114622. 123 456 789-02.01 01 04-4

Это воодушевляет еще больше, чем то же для систем. Любой честный российский инженер будет вдохновлен таким достойным обозначением!

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

Правила присвоения обозначений конструкторским документам устанавливает ГОСТ 2.201-80.
Для полноты ощущений, если документ снабжен листом утверждения, у этого должно быть (по ГОСТ слово «должно» имеет один смысл, по закону 27.12.2002 №184-ФЗ — другое) свое обозначение: к обозначению документа следует добавить шифр ЛУ, отделив его дефисом. Однако для желающих, например:

63755082.425750.001.И2.01-ЛУ

Выводы о пользе

RuGost приводит пример: пенсионеры вынуждены брать в ЗАГСе справку, что они еще живы, и лично доставлять ее в УСЗН (бывший СОбес). Только после этого им выписывают надбавки и льготы. Наш дедуля такую справку тоже брал. Факт.
Хочется верить, что обозначения документов способны сегодня приносить пользу при разработке и согласовании крупных комплектов технической документации. Множественные ссылки на документы заинтересованных сторон проектов, перечисления разных версий — жизнь. Например, заказчик сообщает об ошибке в одном документе, а разработчик его не понимает и вносит ненужные исправления в другой с похожим названием  или еще лучше впопыхах случайно затирает файл с прежними изменениями.

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

«Давайте начнем уже работать, документацию сделаем позже!»
«Прошло два месяца, а у нас вместо системы одна документация!»
«Ваша документация никуда не годится!»
«Вы сорвали жесткий срок, и поэтому…»

• Случай 1: «…вот вам новый, еще более жесткий!»
• Случай 2: «…давайте хотя бы работу сделаем нормально!»
• Случай 3: «А воз и ныне там. Занялись бы вы делом, наконец». Подразумевается, что авторы именно только делом и занимаются, т.е. документов не любят, не читают и не пишут. Как дети!

«Было не срочно, теперь стало срочно». В исконно-российском переводе «нужно вчера».
«Тут вашу документацию Иван Иваныч посмотрел…»

•    Случай 1: проходил случайно мимо один крупный специалист.
•    Случай 2: неполное делегирование полномочий.
•    Случай 3: документы писали умные юристы. (Контекст: мы им заплатили, и править не желаем).
«Каждый день что-нибудь новенькое».
Достали. Мы еще старую версию не прочитали.
Из серии неконструктивного:

•«Мы за вас эту документацию сами напишем!»
•«За это время мы бы все сделали своими силами!»
• «Наши ребята горят желанием сами за вас сделать.»

Можно, не выходя за рамки ГОСТов, систематически вносить свой вклад в дело стандартизации в смысле единообразия документов, передаваемых клиентам. А если смотреть шире — то добиться единственной  цели: от безобразия прийти, наконец, к фантастическому однообразию. Когда каждый человек всегда для решения любого вопроса будет обращаться в одно окно (желательно электронное в Интернете) и не стоять в очередях, даже с современными номерками. Если есть очередь, значит, кто-то боится, что тому, на другой стороне от очереди, может быть нечего делать. Очередь делает человека общительнее и справедливее, а его кругозор и предметы обсуждения масштабнее. Ничто так не влияет на выборы, как очередь в туалет на избирательном участке. Когда человеку не будет нужен паспорт или виза. Когда, если документы потерял, то по той простой причине, что человек важнее бумажек, их можно не искать. МЧС спасает людей, не бумажки. Документы почему-то важнее в обычной жизни, когда человек есть. И он здесь.

Игорь Мялковский

Управляющий по взаимодействию с ВУЗами и отраслевыми учебными центрами

Другие публикации Игорь Мялковский