В соответствии с требованиями стандартов ЕСКД, ЕСПД и КСАС каждому изделию (программе, системе) должно быть присвоено обозначение – группа знаков (цифр и букв), разделённых точками, пробелами, дефисами.
Обозначение присваивается в соответствии с установленными в стандартах правилами для унификации и упрощения идентификации изделий и документации на них, ведения учёта и архива.
Для того чтобы эта простая процедура не казалась бессмысленным магическим ритуалом, рассмотрим порядок действий в зависимости от вида изделия.
Изделия машиностроения и приборостроения
В ЕСКД систему обозначения изделий и их конструкторских документов устанавливает ГОСТ 2.201-80 «Обозначение изделий и конструкторских документов». Для каждого изделия устанавливается своё уникальное обозначение. Обозначение изделия является одновременно обозначением его основного конструкторского документа (чертежа детали или спецификации).
Обозначение изделию может быть присвоено двумя способами: централизовано – в рамках порядка, определённого министерством, ведомством, в рамках отрасли, или децентрализовано – в соответствии с правилами, принятыми в организации-разработчике.
Структура обозначения изделия должна соответствовать приведённой на рисунке 1.
Рисунок 1 – Структура обозначения изделия
Код организации-разработчика состоит из четырёх букв и назначается по кодификатору организаций-разработчиков. Для получения данного кода следует направить письменный запрос от организации-разработчика конструкторской документации во ФГУП «СТАНДАРТИНФОРМ» ( http://www.standards.ru/service/201872.aspx ). Следует учесть, что эта услуга платная.
Допускается для изделий гражданского назначения вместо четырёхзначного буквенного кода использовать код из общероссийского классификатора предприятий и организаций (ОКПО) предприятия-разработчика, который действует на территории Российской Федерации с 1994 года и определяет, к какой сфере относится компания. Код ОКПО является обязательным реквизитом любой организации и меняется только при смене предприятием направления и специфики деятельности, в ином случае он остаётся постоянным на весь срок существования компании.
Код классификационной характеристики следует назначать по общероссийскому классификатору изделий и конструкторских документов ОК 012-93 (классификатору ЕСКД), который является сборником наименований классификационных группировок изделий основного и вспомогательного производства всех отраслей. В данный классификатор включены классификационные характеристики изделий (деталей, сборочных единиц, комплектов, комплексов), на которые разрабатывается конструкторская документация по ЕСКД, в том числе стандартные. Классификатор ЕСКД построен по иерархическому десятичному методу, основанному на логическом переходе от общего к частному в классифицируемом множестве.
Классификатор сопровождается подробными рекомендациями по поиску и определению кода классификационной характеристики изделия. Например, следует определить код классификационной характеристики для блока питания с напряжением питания 220 В переменного тока частотой 50 Гц с тремя выходными каналами напряжением постоянного тока 5, 12, 24 В и активной мощностью 30 Вт. Сначала следует определить номер класса в сетке классов и подклассов по названию изделия. В данном случае подходит класс 43… «Микросхемы, приборы полупроводниковые, электровакуумные, пьезоэлектрические, квантовой электроники, резисторы соединители, преобразователи электроэнергии, средства вторичного электропитания». Там же следует выбрать подкласс 436… «Системы и источники вторичного электропитания». По сетке групп, подгрупп и видов следует определить группу в выбранном подклассе, опираясь на характеристики разрабатываемого устройства: 4366… «Источники вторичного электропитания многоканальные до 3 выходных каналов вкл.», подгруппу: 43661… «С входным переменным однофазным напряжением и выходными параметрами» и вид: 436614 «Мощностью, Вт св. 10 до 100 вкл. напряжением, В до 100 вкл.». Таким образом, разработанный блок питания имеет код классификационной характеристики «436614».
Порядковый регистрационный номер – трёхзначный цифровой код (от 1 до 999), при централизованном присвоении обозначения определяется кодом организации на основании запроса, форму которого устанавливают министерства, а при децентрализованном – в соответствии с правилами, принятыми на предприятии-разработчике изделия. Например, данный номер может быть порядковым номером записи в карточке учёта обозначений изделий. Форма и порядок ведения карточки учёта обозначений установлены в ГОСТ 2.201-80.
Таким образом, для рассмотренного примера по выбору классификационной характеристики обозначение изделия может выглядеть следующим образом:
- при использовании кода организации-разработчика из четырёх букв:
АБВГ.436614.001
- при использовании кода ОКПО:
98765432.436614.001
При групповом и базовом способах выполнения конструкторских документов (подробнее об этом способе – в ГОСТ 2.113-75) к обозначению изделия (базовому обозначению) через дефис добавляется порядковый номер исполнения от 01 до 98. При большой номенклатуре изделий, обладающих общими конструктивными признаками, допускается применять дополнительный номер исполнения, который записывается через точку и должен быть в виде двухзначного числа, кроме 00. Структура такого обозначения показана на рисунке 2.
Рисунок 2 – Применение номера исполнения и дополнительного номера исполнения
Обозначения неосновных конструкторских документов должны состоять из обозначения изделия и кода документа (рисунок 3).
Рисунок 3 – Обозначение неосновного конструкторского документа
Код документа не должен содержать более четырёх знаков, включая номер части документа, записывается к обозначению изделий без пробела, присваивается в соответствии с таблицей 3 ГОСТ 2.102-2013 «Виды и комплектность конструкторских документов».
Обозначение конструкторских документов, разработанных на этапе эскизного проектирования, формируется в соответствии с формой, указанной на рисунке 4.
Рисунок 4 – Обозначение эскизных конструкторских документов
Программы и программные документы
Обозначения программ и программных документов присваиваются в соответствии с указаниями ГОСТ 19.103-77 «Обозначения программ и программных документов». Как и в ЕСКД, в ЕСПД предусматривается, что обозначение изделия является одновременно обозначением его программного документа – спецификации. Структура обозначения программ приведена на рисунке 5.
Рисунок 5 – Структура обозначения программ
Код страны присваивается в соответствии с указаниями ГОСТ 7.67-2003 «Коды названий стран», при этом выбор кодировки (латиница, кириллица или цифровой код) осуществляется разработчиком в соответствии с правилами, принятыми на предприятии. В качестве кода организации-разработчика допустимо использовать четырёхзначный буквенный код или код ОКПО.
В ГОСТ 19.103 указано, что регистрационный номер программы следует присваивать в соответствии с Общесоюзным классификатором программ, однако он так и не вышел в свет, поэтому допускается присваивать такой код от 00001 до 99999 в соответствии с порядком, установленным на предприятии-разработчике программы.
В отдельных случаях для формирования регистрационного номера программы используют общероссийский классификатор продукции по видам экономической деятельности ОК 034-2014 (ОКПД2), раздел 62 «Продукты программные и услуги по разработке программного обеспечения; консультационные и аналогичные услуги в области информационных технологий».
Порядковый номер издания программы должен иметь формат от 01 до 99.
Пример обозначения программы:
- при использовании кода организации-разработчика из четырёх букв:
РОФ.АБВГ.62.01.29-01
643.АБВГ.62.01.29-01
- при использовании кода ОКПО:
РОФ.98765432.62.01.29-01
RU.98765432.62.01.29-01
RUS.98765432.62.01.29-01
643.98765432.62.01.29-01
Структура обозначения программных документов показана на рисунке 6.
Рисунок 6 – Структура обозначения программных документов
Порядковый номер редакции документа должен иметь формат от 01 до 99. Код вида документа присваивается в соответствии с таблицей 4 ГОСТ 19.101-77 «Виды программ и программных документов». При необходимости, документу присваивают номер документа данного вида в порядке возрастания от 01 до 99, номер части документа в порядке возрастания от 1 до 9.
Примеры обозначения документа «Руководство оператора» (второй такой документ на данную программу, часть 3):
РОФ.АБВГ.62.01.29-01 34 02-3
643.АБВГ.62.01.29-01 34 02-3
РОФ.98765432.62.01.29-01 34 02-3
RU.98765432.62.01.29-01 34 02-3
RUS.98765432.62.01.29-01 34 02-3
643.98765432.62.01.29-01 34 02-3
Окончательный вариант применяемой системы обозначения программ и программных документов должен быть определён предприятием-разработчиком во внутренних нормативных документах.
Обозначения для документации на автоматизированные системы
Для формирования обозначения автоматизированной системы следует обратиться к указаниям ГОСТ 34.201-89. В соответствии с ними обозначение автоматизированной системы должно состоять из трёх позиций: кода организации-разработчика системы, кода классификационной характеристики системы (её части) и регистрационного номера.
Выбор кода организации-разработчика указанный стандарт предлагает осуществлять в соответствии с общесоюзным классификатором предприятий, учреждений и организаций. Очевидно, на текущий момент следует использовать не общесоюзный утративший силу документ, а общероссийский классификатор – ОКПО. В качестве кода организации-разработчика допустимо также использовать четырёхбуквенный код от ФГУП «СТАНДАРТИНФОРМ», порядок получения которого описан ранее.
Код классификационной характеристики системы следует выбирать из раздела 63 «Услуги в области информационных технологий» ОК 034-2014 (ОКПД2), который заменил упомянутый в ГОСТ 34.201-89 общесоюзный классификатор продукции, а также отменённый с 01 января 2017 года общероссийский классификатор продукции (ОКП).
Необходимо учитывать, что код классификационной характеристики из ОКПД2 может быть выбран по наименованию объекта автоматизации, например: 26.51.43.120 – системы информационные электроизмерительные, комплексы измерительно-вычислительные и установки для измерения электрических и магнитных величин (например, автоматизированная информационно-измерительная система коммерческого учёта электроэнергии (АИИС КУЭ)), 70.22.17 – услуги по управлению бизнес-процессами (АСУ БП); 26.20.40.140 – средства защиты информации, а также информационные и телекоммуникационные системы, защищённые с использованием средств защиты информации (информационные интернет-порталы).
Также ГОСТ 34.201-89 для присвоения указанной характеристики предлагает использовать общесоюзный классификатор подсистем и комплексов задач АСУ (ОКПКЗ). Данный классификатор на территории РФ прекратил своё действие, а замены ему разработано не было. Поэтому альтернативы выбору классификационной характеристики автоматизированной системы по ОКПД2 на текущий момент нет.
Присвоение регистрационного номера системе производится согласно правилам учёта выпускаемых систем, принятым на предприятии-разработчике. Для каждого кода классификационной характеристики системы должна вестись своя нумерация.
Структура обозначения документов на автоматизированные системы по ГОСТ 34.201-89 показана на рисунке 7.
Рисунок 7 – Структура обозначения документов на автоматизированные системы
Код документа отделяется от обозначения системы точкой, выбирается из таблицы 2 ГОСТ 34.201-89 (для документов, определённых данным стандартом). Для дополнительных документов первый знак выбирают по обозначению вида документа из таблицы 1, вторым знаком указывают порядковый номер документа данного вида.
Остальные позиции включают в обозначение документа при необходимости (номер редакции документа и номер части документа – со второй по порядку, признак документа – если он выполнен в электронном виде на машинном носителе). Все эти позиции отделяются от предыдущих в обозначении точкой, без пробелов.
Таким образом, обозначение АИИС КУЭ может выглядеть так:
98765432.26.51.43.120.012
АБВГ.26.51.43.120.012
Пример обозначения документа «Технологическая инструкция» (третий документ такого вида, вторая редакция, часть 5, выполнен в электронном виде):
98765432.26.51.43.120.012.И2.03.2-05.М
АБВГ.26.51.43.120.012.И2.03.2-05.М
Схема структурная комплекса технических средств (единственный документ такого вида в составе проекта, единственная редакция, в одной части, выпущен на бумаге):
98765432.26.51.43.120.012.С1
АБВГ.26.51.43.120.012.С1.
В заключении следует отметить, что описанная система присвоения обозначений изделиям и документам обязательна к применению, если есть на это требование заказчика. При отсутствии таких требований допускается использовать ту уникальную систему идентификации, которая принята в организации-разработчике. Но стоит иметь в виду, что без специальных пояснений эта система не будет понятна никому, а обозначение, присвоенное в соответствии со стандартами, сможет расшифровать любой специалист (конструктор, разработчик, программист).
Получение децимального номера
Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru!
@twriters 
чат для технических писателей в Telegram
Зарегистрируйтесь
| puhata
Эксперт Сообщений: 346 | #1 Мне нравится0 06.09.2011 15:21:22 На разработку некоего прибора нужно получить… некий децимальный номер, что это такое и где его получают? |
| znapa Не определившийся Сообщений: 13 | #2 Мне нравится0 07.09.2011 20:21:14 Можно обратиться за справкой в Федеральное агентство по метрологии http://www.gost.ru . |
| #3 Мне нравится0 13.09.2011 14:27:53
| |
нигде его не получают! Его разрабатывают и принимают к использованию в вашей организации, в соответствии с ГОСТ 19.103. (На программные документы)| puhata
Эксперт Сообщений: 346 | #4 Мне нравится0 13.09.2011 18:01:30
Как? Сам придумал его и добавил в документацию? | ||
| гена
Эксперт Сообщений: 753 | #5 Мне нравится0 13.09.2011 18:08:55
Отправят в Росстандарт сначала. Работаю по-старинке… | ||
| writer
Администратор Сообщений: 1890 | #6 Мне нравится0 11.10.2011 17:01:57 Итак…внимание правильный ответ… Внизу скан официального письма из Росстандарта |
| Лисс Не определившийся Сообщений: 4 | #7 Мне нравится0 02.11.2011 12:07:43 Посмотритте ГОСТ 2.201-80(статус действующий) для изделия. |
| Ksushka
Не определившийся Сообщений: 9 | #8 Мне нравится0 20.03.2012 18:31:04 Нам на днях выдали децимальный номер — четыре заглавные буквы |
| writer
Администратор Сообщений: 1890 | #9 Мне нравится0 22.03.2012 16:05:26
Ksushka! Спасибо за обновление информации! Трудности при получении были? | ||
| Омуль Не определившийся Сообщений: 2 | #10 Мне нравится0 23.03.2012 16:07:58 Добрый день! |
| latex Эксперт Сообщений: 453 | #11 Мне нравится0 27.03.2012 09:07:39
А вот и ответ
Кто выдает, тот и знает кому. Подайте запрос. | ||||
| Ksushka
Не определившийся Сообщений: 9 | #12 Мне нравится0 03.05.2012 10:33:35
Сказать не могу, не я этим занималась, к сожалению. | ||
| writer
Администратор Сообщений: 1890 | #13 Мне нравится0 13.11.2012 16:00:45
А можете описать процедуру получения Децимального номера, эта тема очень многих здесь интересует тем более у вас такой свежий опыт в этом деле. | ||
| perepelini Не определившийся Сообщений: 27 | #14 Мне нравится0 14.11.2012 09:59:49 Процедура проста, как 2+2. а) Составить письмо в ФГУП «СТАНДАРТИНФОРМ» на имя и.о. Генерального директора Коровайцева Алексея Анатольевича, в котором следует указать области разработки конструкторских документов согласно ОК ЕСКД 012-93 с примерами продукции, на которую будет составляться конструкторская документация. В данном письме также указывают банковские реквизиты, по которым следует выставить счёт для оплаты вашей организацией. == |
| perepelini Не определившийся Сообщений: 27 | #15 Мне нравится0 13.11.2012 14:58:11 У нас не было никаких трудностей. Стоимость данной услуги 3 960 рублей (по состоянию на сентябрь 2012 г.). == |
| puhata
Эксперт Сообщений: 346 | #16 Мне нравится0 14.11.2012 10:27:57 Спасибо, за информацию, как раз планируем получать |
| Христина Арженовская Не определившийся Сообщений: 6 | #17 Мне нравится1 27.03.2013 10:05:10 Добрый день! Возникла проблема! подскажите пожалуйста решение. Необходимо присвоить документам коды по ГОСТ. нашла 2 госта на эту тему: ГОСТ 19.103-77 и 2.201-80. не могу понять с каким всетаки работать! Изменено: Христина Арженовская — 01.04.2013 14:45:05 |
| writer
Администратор Сообщений: 1890 | #18 Мне нравится0 27.03.2013 10:07:44 |
| Христина Арженовская Не определившийся Сообщений: 6 | #19 Мне нравится0 27.03.2013 10:36:52 или посоветуйте может есть какая горячая линия консультации по гостам? |
| Ден
Эксперт Сообщений: 309 | #20 Мне нравится0 27.03.2013 12:50:16 А каким документам? Как то подробнее ситуацию объясните Торопливость в выводах может привести к неприятностям |
| ‘Христина’ Арженовская Не определившийся Сообщений: 6 | #21 Мне нравится0 27.03.2013 13:08:22 мы работаем над частью ОКР по созданию программного обеспечения. моя задача состоит в подготовке комплекта документов по ГОСТ 19.101-77. в документах могут предполагаться констукторские чертежи |
| ‘ADVANCED’
Эксперт Сообщений: 1782 | #22 Мне нравится0 27.03.2013 13:53:00 ‘Христина’ Арженовская пишет: Изменено: ‘ADVANCED’ — 01.04.2013 14:46:43 |
| »»Христина»» Арженовская Не определившийся Сообщений: 6 | #23 Мне нравится0 27.03.2013 14:39:14 с этими кодами все понятно, меня интересует полный код документа (в некоторых вариациях называют децибальный номер), который в колонтитулах на каждой странице проставляется! |
| »»Христина»» Арженовская Не определившийся Сообщений: 6 | #24 Мне нравится0 27.03.2013 14:45:18 даже спрошу точнее, первые символы этого номера. Все таки те, которые символьные и нужно за деньги получать в госслужбе или достаточно просто ОКПО? |
| writer
Администратор Сообщений: 1890 | #25 Мне нравится0 27.03.2013 16:52:00
| ||
Введение
Структура
проекта
Правила оформления
==================================
Введение
В
данной статье систематизированы
основные правила оформления программных документов по требованиям ЕСПД.
Для более полного понимания всех требований к оформлению Вы можете
самостоятельно ознакомиться с комплексом ГОСТ 19, скачав его с
просторов интернета.
На верх
==================================
Структура
проекта
Из
всего множества программных документов, для создания минимального
проекта, вам понадобятся: Техническое задание, Описание программы,
Руководство программиста (или оператора). Остальные необходимо писать в
зависимости от ваших целей. Например, если Вам необходимо передать в
эксплуатацию, то Вам понадобятся: Программа и методика испытаний,
Формуляр, Руководство по техническому обслуживанию, Руководство
системного программиста и т.д.
Общие схемы и структура наиболее полного комплекта
программной документации приведены в файле «Структура программного
проекта» Скачать
На верх
==================================
Правила оформления
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ
19.101-77, ГОСТ
19.103-77,
ГОСТ 19.104-78*,
ГОСТ 19.105-78*,
ГОСТ 19.106-78*,
ГОСТ 19.604-78* (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
Например: для Руководства оператора — ГОСТ
19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и
оформлению.
На верх
==================================
ГОСТ
19.101-77 (Виды программ и программных документов)
Из данного ГОСТа мы получаем общие сведения о структуре всего проекта
программной документации. Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает виды программ и
программных документов для вычислительных машин, комплексов и систем независимо
от их назначения и области применения. - Документация, разработанная на программу, может
использоваться для реализации и передачи программы на носителях данных, а также
для изготовления программного изделия. - К программным относят документы, содержащие сведения,
необходимые для разработки, изготовления, сопровождения и эксплуатации
программ. -
Допускается объединять отдельные виды эксплуатационных документов (за
исключением ведомости эксплуатационных документов и формуляра). Необходимость
объединения этих документов указывается в техническом задании. Объединенному
документу присваивают наименование и обозначение одного из объединяемых
документов.
Виды программных документов и их содержание
| Код | Вид программного документа | Содержание программного документа |
| — | Спецификация | Состав программы и документации на нее |
| 05 | Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
| 12 | Текст программы | Запись программы с необходимыми комментариями |
| 13 | Описание программы | Сведения о логической структуре и функционировании программы |
| 51 | Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
| — | Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| 81 | Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| — | Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
Виды эксплуатационных документов и их содержание
| Код | Вид эксплуатационного документа | Содержание эксплуатационного документа |
| 20 | Ведомость эксплуатационных документов | Перечень эксплуатационных документов на программу |
| 30 | Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
| 31 | Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
| 32 | Руководство системного программиста | Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения |
| 33 | Руководство программиста | Сведения для эксплуатации программы |
| 34 | Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
| 35 | Описание языка | Описание синтаксиса и семантики языка |
| 46 | Руководство по техническому обслуживанию | Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
На верх
==================================
ГОСТ
19.103-77 (Обозначение программ и программных
документов)
Из
данного ГОСТа мы получаем структуру обозначения программ и программных
документов. Ниже приведены наиболее важные разделы.Структура обозначения программ и ее программного
документа — спецификации:
Структура обозначения других программных
документов:
Пример: А.В.00001-01 20 01
На верх
==================================
ГОСТ 19.104-78* (Основные надписи)
Из
данного ГОСТа мы получаем формы, размеры, расположение и порядок заполнения
основных надписей листа утверждения и титульного листа в программных документах. Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает формы, размеры,
расположение и порядок заполнения основных надписей листа утверждения и
титульного листа в программных документах, предусмотренных стандартами ЕСПД,
независимо от способов их выполнения.
Из за значительного объема информации в данном ГОСТе и для экономии
места на данной странице рекомендую самостоятельно просмотреть ГОСТ 19.104-78*. Готовый пример оформления Вы можете просмотреть в любом программном документе, предоставленном в разделе СКАЧАТЬ
На верх
==================================
ГОСТ 19.105-78* (Общие требования к программным документам)
Из
данного ГОСТа мы получаем общие требования к оформлению
программных документов. Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает общие требования к
оформлению программных документов для вычислительных машин, комплексов и
систем, независимо от их назначения и области применения и предусмотренных
стандартами Единой системы программной документации (ЕСПД) для любого способа
выполнения документов на различных носителях данных. - Программный документ состоит из следующих условных
частей: - титульной;
- информационной;
- основной;
- регистрации изменений.
- Титульная часть состоит из листа утверждения и
титульного листа. Правила оформления листа утверждения и титульного листа
устанавливаются по ГОСТ 19.104-78. - Информационная часть должна состоять из аннотации и
содержания. - Необходимость включения информационной части в
различные виды программных документов установлена соответствующими стандартами
ЕСПД на эти документы. - В аннотации приводят сведения о назначении
документа и краткое изложение его основной части. - Содержание включает перечень записей о структурных
элементах основной части документа, в каждую из которых входят: - обозначение структурного
элемента (номер раздела, подраздела и т.д.); - наименование структурного
элемента; - адрес структурного элемента на носителе данных (например, номер
страницы, номер файла и т.п.). - Состав и структура основной части программного
документа устанавливаются стандартами ЕСПД на соответствующие документы. - Часть регистрации изменений (должна присуствовать в каждом программном документе)
- О каждом изменении программного документа в этой
части делается запись в соответствии с требованиями ГОСТ 19.603-78.
На верх
==================================
ГОСТ 19.106-78* (Общие требования к программным документам,
выполненным печатным
способом)
Из
данного ГОСТа мы получаем общие правила для печатного способа выполнения программных документов. Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает правила выполнения программных документов
для вычислительных машин, комплексов и систем независимо от их назначения и
области применения и предусмотренных стандартами Единой системы программной
документации (ЕСПД) для печатного способа выполнения. - Стандарт не распространяется на программный документ «Текст программы».
- Состав и структура программного документа
устанавливается по ГОСТ 19.105-78. - Программный документ выполняют на одной стороне листа, через два интервала;
допускается через один или полтора интервала. - Программные документы оформляют:
- на листах формата А4 (ГОСТ 2.301-68) — при
изготовлении документа машинописным или рукописным способом (форма 1).
Допускается оформление на листах формата А3.
Форма 1.
- Материалы программного документа располагают в следующей
последовательности: - титульная часть:
- лист утверждения (не входит в общее количество
листов документа); - титульный лист (первый лист документа);
- информационная часть:
- аннотация;
- лист содержания;
- основная часть:
- текст документа (с рисунками, таблицами и т.п.);
- приложения;
- перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных
документов; - часть регистрации изменений:
- лист регистрации изменений.
- Аннотацию размещают на отдельной (пронумерованной)
странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел. - В аннотации указывают издание программы, кратко
излагают назначение и содержание документа. Если документ состоит из нескольких
частей, в аннотации указывают общее количество частей. - Содержание документа размещают на отдельной
(пронумерованной) странице (страницах) после аннотации, снабжают заголовком
«СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц
документа. - Заголовки разделов пишут прописными буквами и размещают симметрично
относительно правой и левой границ текста. - Заголовки подразделов записывают с абзаца строчными буквами (кроме
первой прописной). - Переносы слов в заголовках не допускаются. Точку в
конце заголовка не ставят.
- Расстояние между заголовком и последующим текстом,
а также между заголовками раздела и подраздела должно быть равно: - при выполнении документа машинописным способом —
двум интервалам. - Для разделов и подразделов, текст которых
записывают на одной странице с текстом предыдущего раздела, расстояние между
последней строкой текста и последующим заголовком должно быть равно: - при выполнении документа машинописным способом —
трём машинописным интервалам. - Разделы, подразделы, пункты и подпункты следует
нумеровать арабскими цифрами с точкой. - В пределах раздела должна быть сквозная нумерация
по всем подразделам, пунктам и подпунктам, входящим в данный раздел. - Нумерация подразделов включает номер раздела и
порядковый номер подраздела, входящего в данный раздел, разделённые точкой
(2.1; 3.1 и т. д.). - При наличии разделов и подразделов к номеру
подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1,
3.1.1.1 и т.д.).
Пример структуры текста программного документа и
нумерации его разделов, подразделов, пунктов и подпунктов.
- Текст документа должен быть кратким, четким,
исключающим возможность неверного толкования. - Термины и определения должны быть едиными и
соответствовать установленным стандартам, а при их отсутствии — общепринятым в
научно-технической литературе, и приводиться в перечне терминов. - Необходимые пояснения к тексту документа могут оформляться
сносками. - Сноска обозначается цифрой со скобкой, вынесенными
на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)…»
или «бумага5)». - Если сноска относится к отдельному слову, знак
сноски помещается непосредственно у этого слова, если же к предложению целом,
то в конце предложения. Текст сноски располагают в конце страницы и отделяют от
основного текста линией длиной 3 см, проведённой в левой части страницы. - Иллюстрации, если их в данном документе более
одной, нумеруют арабскими цифрами в пределах всего документа. - Формулы в документе, если их более одной,
нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках
на уровне формулы. - Значение символов и числовых коэффициентов,
входящих в формулу, должны быть приведены непосредственно под формулой.
Значение каждого символа печатают с новой строки в той последовательности, в
какой они приведены в формуле. Первая строка расшифровки должна начинаться со
слова «где», без двоеточия после него. - В программных документах допускаются ссылки на
стандарты (кроме стандартов предприятий), технические условия и другие
документы (например, документы органов Государственного надзора, правила и
нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают
их обозначение. - Ссылаться следует на документ в целом или на его
разделы (с указанием обозначения и наименования документа, номера и
наименования раздела или приложения). При повторных ссылках на раздел или
приложение указывают только номер. - В примечаниях к тексту и таблицам указывают только
справочные и пояснительные данные. - Одно примечание не нумеруется. После слова
«Примечание» ставят точку. - Несколько примечаний следует нумеровать по порядку
арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие. - Сокращения слов в тексте и надписях под иллюстрациями
не допускаются. - Иллюстрированный материал, таблицы или текст
вспомогательного характера допускается оформлять в виде приложений. - Каждое приложение должно начинаться с новой
страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь
тематический заголовок, который записывают симметрично тексту прописными
буквами.
На верх
==================================
ГОСТ 19.604-78* (Правила внесения изменений в программные
документы, выполненные
печатным способом)
Из данного ГОСТа мы
получаем
общие правила внесения
изменений в программные документы (в итоге, для создания проекта, нам понадобится только лист регистрации изменений).
- Настоящий стандарт устанавливает правила внесения
изменений в программные документы, предусмотренные стандартами Единой системы
программной документации (ЕСПД) и выполненные печатным способом.
Из за значительного объема информации в данном ГОСТе и для экономии места на
данной странице рекомендую самостоятельно просмотреть ГОСТ 19.604-78*. Готовый
пример оформления «листа регистрации изменений» Вы можете просмотреть в любом программном документе,
предоставленном в разделе СКАЧАТЬ
На верх
==================================
<Предыдущий> <Содержание> <Следующий>
Согласно стандартам ЕСКД, ЕСПД и КСАС каждой программе, системе, документу должно быть присвоено обозначение, которое состоит из группы цифр и букв, разделённых точками, пробелами, дефисами. Обозначение присваивается по правилам для унификации и упрощения идентификации изделий и документации на них, ведения учёта и архива.
Присвоить номер, код или шифр документу, со сторону кажется целой наукой, тайным знанием. Однако, это проще чем кажется! Можно ли не присваивать этот мистический номер созданному техническому документу по ГОСТу? Нет, он необходим, чтобы в документации был порядок. Иначе поиск, хранение и учёт документов будут проблематичны.
Для начала следует запомнить, что документ не имеет номера, кода или шифра, а имеет обозначение, если мы говорим про документы из серии ГОСТов 19 или 34.
Обозначения документов по 19 и 34 ГОСТам отличаются друг от друга.
По ГОСТу 34
В 34 ГОСТе обозначение документа присваивается по ГОСТу 34.201-89, но смотря туда, не каждый сразу способен разобраться откуда берётся какая цифра.
Номер согласно ГОСТу 34 выглядит следующим образом:
A.Б.ВВВ.ГГ.ДД.ЕЕ-Ж.М
Расшифровка обозначений:
А — код организации-разработчика системы, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
Б — код классификационной характеристики типа системы или её части, который присваивается по ОКП (Общероссийский классификатор продукции). Раздел классификатора по автоматизированным системам, идёт со строчки — 425000 Программно-технические комплексы для автоматизированных систем.
ВВВ — регистрационный номер автоматизированной системы или её части. Данный номер ведётся в журнале учёта на предприятии. Если журнал учёта не ведётся, то можно указать номер 001.
ГГ — код документа. Коды документов определены ГОСТом 34.201-89. Для каждого наименования документа свой номер. Например, Описание автоматизируемых функций – П3, Руководство пользователя – И3, Ведомость эскизного проекта – ЭП.
ДД — порядковый номер документа с одинаковым названием. Допустим, у вас 5 Пояснительных записок для разных компонентов программы, чтобы не запутаться в них им присваиваются номера 01, 02, 03, 04 и 05. Если документ один с таким названием, то значение пропускается.
ЕЕ — порядковый номер редакции документа. Документ может переписываться несколько раз, согласно пожеланиям заказчика. При официальной корректировке документа, по замечаниям заказчика, проставляется номер редакции. При первой передаче документа данное значение не проставляется, при второй передаче документа уже ставится значение 02.
Ж — порядковый номер части документа. Большие документы, для удобства сшивания, делятся на несколько частей. Если документ не разделён на части, то данное значение пропускается.
М — обозначение М, проставляется, если документ представлен не в печатном виде, а на диске или флешке. Если документ в печатном виде, то в данном значение пропускается.
ЛУ — обозначение ЛУ проставляется, только Листу утверждения.
Таким образом, можно получить следующее обозначение:
11119632.4251005.004.ПА.10.02-3 (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, часть 3);
11119632.4251005.005.ПА.10.02-М (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, на диске);
11119632.4251005.002.ПА (Описание программного обеспечения).
11119632.4251005.008.И2 (Технологическая инструкция).
11119632.4251005.195.ПС (Паспорт).
ПО ГОСТу 19
В 19 ГОСТе обозначение документа присваивается по ГОСТу 19.103-77.
Номер согласно ГОСТу 19 выглядит следующим образом:
A.Б.ВВВВВ-ГГ ДД ЕЕ-Ж
Расшифровка обозначений:
A — код страны, где разработан документ. Например, RU для России. Остальные обозначения указаны в стандарте ISO 3166-1.
Б — код организации-разработчика, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
ВВВВВ — регистрационный номер программы, который присваивается по ОКП (Общероссийский классификатор продукции). Допускается присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.
ГГ — порядковый номер редакции документа. Например, 01, 02,03.
ДД — код вида документа, который присваивается в соответствии с ГОСТ 19.101-77. Например, 34 – Руководство оператора, 12 – Текст программы, 33 – Руководство программиста.
ЕЕ — порядковый номер документа данного вида.
Ж — порядковый номер части документа.
Таким образом, можно получить следующее обозначение:
RU.11119632.20006–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.30706–10 32 02–03 (Руководство системного программиста, 10 редакции, 2-й документ данного вида, 3-я часть данного документа);
RU.11119632.10908–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.28051–01 32 (Руководство системного программиста, 1 редакции).
RU.11119632.44009–06 33 (Руководство программиста, 6 редакции).
RU.11119632.30101–02 81 (Пояснительная записка, 2 редакции).