Выбор (уточнение) состава комплекта документов

Смотрите:
Состав комплекта документов на изделия
Состав комплекта ремонтных документов на изделия
Состав комплекта документов на программу (программное изделие)
Состав комплекта документов на автоматизированную систему
Состав комплекта документов при инициативной разработке
Состав комплекта документов при иных видах разработки

Выбор (уточнение) состава комплекта документов определяется предметом разработки (и документирования), а также целями и задачами документирования (видом разработки). Редакция от 12.03.2021.

Создан 17.02.2010 17:09:02

- Выбор (уточнение) состава комплекта документов

Состав комплекта документов на изделия

Состав комплекта документов на изделия регламентирован ГОСТ 2.102-68.

Документы подразделяют на виды, указанные в таблице ниже.

Вид документа

Код документа

Назначение документа

Чертеж детали

-

Документ, содержащий изображение детали и другие данные, необходимые для ее изготовления и контроля

Сборочный чертеж

СБ

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

Чертеж общего вида

ВО

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

Теоретический чертеж

ТЧ

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

Габаритный чертеж

ГЧ

Документ, содержащий контурное (упрощенное) изображение изделия с габаритными, установочными и присоединительными размерами

Электромонтажный чертеж

МЭ

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

Монтажный чертеж

МЧ

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

Упаковочный чертеж

УЧ

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

Схема

По ГОСТ 2.701

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

Спецификация

-

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

Ведомость спецификаций

ВС

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

Ведомость ссылочных документов

ВД

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

Ведомость покупных изделий

ВП

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

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

ВИ

Документ, содержащий перечень покупных изделий, разрешенных к применению в соответствии с ГОСТ 2.124

Ведомость держателей подлинников

ДП

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

Ведомость технического предложения

ПТ

Документ, содержащий перечень документов, вошедших в техническое предложение

Ведомость эскизного проекта

ЭП

Документ, содержащий перечень документов, вошедших в эскизный проект

Ведомость технического проекта

ТП

Документ, содержащий перечень документов, вошедших в технический проект

Пояснительная записка

ПЗ

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

Технические условия

ТУ

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

Программа и методика испытаний

ПМ

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

Таблица

ТБ

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

Расчет

РР

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

Инструкция

И...

Документ, содержащий указания и правила, используемые при изготовлении изделия (сборке, регулировке, контроле, приемке и т. п.)

Эксплуатационные документы

Руководство по эксплуатации

РЭ

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

Инструкция по монтажу, пуску, регулированию и обкатке изделия

ИМ

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

Формуляр

ФО

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

Паспорт

ПС

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

Этикетка

ЭТ

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

Каталог деталей и сборочных единиц

КДС

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

Нормы расхода запасных частей

НЗЧ

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

Нормы расхода материалов

НМ

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

Ведомость комплекта запасных частей, инструмента и принадлежностей (ЗИП)

ЗИ

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

Учебно-технические плакаты

УП

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

Ведомость эксплуатационных документов

ВЭ

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

Ремонтные документы по ГОСТ 2.602

[из 1.2 ГОСТ 2.102-68]

Состав комплекта ремонтных документов на изделия

К ремонтным документам относят текстовые и графические рабочие конструкторские документы, которые в отдельности или в совокупности дают возможность обеспечивать подготовку ремонтного производства, произвести ремонт изделия и его контроль после ремонта [из 6.1.1 ГОСТ 2.602-2013]

Документы подразделяют на виды, указанные в таблице 2.

Таблица 2 - Виды ремонтных документов

Вид документа

Определение

Руководство по ремонту

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

Общее руководство по ремонту

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

Технические условия на ремонт

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

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

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

Чертежи ремонтные

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

Нормы расхода запасных частей на ремонт

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

Нормы расхода материалов на ремонт

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

Ведомость ЗИП на ремонт

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

Техническая документация на средства оснащения ремонта

Документация, содержащая информацию для изготовления, испытания и приемки ремонтно-технологического и имитационно-стендового оснащения ремонта. В состав документации включают:

Ведомость документов для ремонта

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

[из 6.1.2 ГОСТ 2.602-2013]

Состав комплекта документов на программу (программное изделие)

Состав комплекта документов на программу (программное изделие) регламентирован ГОСТ 19.101-77.

Виды программных документов и их содержание приведены в таблице.

Вид программного документа

Содержание программного документа

Спецификация

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

Ведомость держателей подлинников

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

Текст программы

Запись программы с необходимыми комментариями

Описание программы

Сведения о логической структуре и функционировании программы

Программа и методика испытаний

Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля

Техническое задание

Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний

Пояснительная записка

Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений

Эксплуатационные документы

Сведения для обеспечения функционирования и эксплуатации программы

[из 2.2 ГОСТ 19.101-77]

Виды эксплуатационных документов и их содержание приведены таблице.

Вид эксплуатационного документа

Содержание эксплуатационного документа

Ведомость эксплуатационных документов

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

Формуляр

Основные характеристики программы, комплектность и сведения об эксплуатации программы

Описание применения

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

Руководство системного программиста

Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения

Руководство программиста

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

Руководство оператора

Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание языка

Описание синтаксиса и семантики языка

Руководство по техническому обслуживанию

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

[из 2.3 ГОСТ 19.101-77]

Состав комплекта документов на автоматизированную систему

Состав комплекта документов на автоматизированную систему регламентирован ГОСТ 34.201-89.

Наименования конкретных документов, разрабатываемых при проектировании системы в целом или ее части, приведены в таблице 2.

Стадия создания

Наименование документа

Код документа

Часть проекта

Принадлежность к

Дополнительные указания

ПСД

ЭД

ЭП

Ведомость эскизного проекта

ЭП*

ОР

-

-

Пояснительная записка к эскизному проекту

П1

ОР

-

-

ЭП, ТП

Схема организационной структуры

СО

ОР

-

-

Допускается включать в документ П3 или ПВ

Схема структурная комплекса технических средств

С1*

ТО

Х

Допускается включать в документ П9

Схема функциональной структуры

С2*

ОР

-

-

При разработке документов СО, С1, С2, С3 на стадии ЭП допускается их включать в документ П1

Перечень заданий на разработку специализированных (новых) технических средств

В9

ТО

Х

-

При разработке на стадии ТП допускается включать в документ П2

Схема автоматизации

С3*

ТО

Х

-

Технические задания на разработку специализированных (новых) технических средств

-

ТО

-

-

В состав проекта не входят

ТП

Задания на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы

-

ТО

Х

-

В состав проекта не входят

Ведомость технического проекта

ТП*

ОР

-

-

Ведомость покупных изделий

ВП*

ОР

-

-

Перечень входных сигналов и данных

В1

ИО

-

-

Перечень выходных сигналов (документов)

В2

ИО

-

-

Перечень заданий на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы

В3

ТО

Х

Допускается включать в документ П2

Пояснительная записка к техническому проекту

П2

ОР

-

-

Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию

Описание автоматизируемых функций

П3

ОР

-

-

Описание постановки задач (комплекса задач)

П4

ОР

-

-

Допускается включать в документы П2 или П3

Описание информационного обеспечения системы

П5

ИО

-

-

Описание организации информационной базы

П6

ИО

-

-

ТП

Описание систем классификации и кодирования

П7

ИО

-

-

Описание массива информации

П8

ИО

-

-

Описание комплекса технических средств

П9

ТО

-

-

Для задачи допускается включать в документ 46 по ГОСТ 19.10

Описание программного обеспечения

ПА

ПО

-

-

Описание алгоритма (проектной процедуры)

ПБ

МО

-

-

Допускается включать в документы П2, П3 или П4

Описание организационной структуры

ПВ

ОО

-

-

План расположения

С8

ТО

Х

-

Допускается включать в документ П9

Ведомость оборудования и материалов

-

ТО

Х

-

Локальный сметный расчет

Б2

ОР

Х

-

ТП, РД

Проектная оценка надежности системы

Б1

ОР

-

-

Чертеж формы документа (видеокадра)

С9

ИО

-

Х

На стадии ТП допускается включать в документы П4 или П5

РД

Ведомость держателей подлинников

ДП*

ОР

-

-

Ведомость эксплуатационных документов

ЭД*

ОР

-

Х

Спецификация оборудования

В4

ТО

Х

-

Ведомость потребности в материалах

В5

ТО

Х

-

Ведомость машинных носителей информации

ВМ*

ИО

-

Х

Массив входных данных

В6

ИО

-

Х

РД

Каталог базы данных

В7

ИО

-

Х

Состав выходных данных (сообщений)

В8

ИО

-

Х

Локальная смета

Б3

ОР

Х

-

Методика (технология) автоматизированного проектирования

И1

ОО

-

Х

Технологическая инструкция

И2

ОО

-

Х

Руководство пользователя

И3

ОО

-

Х

Инструкция по формированию и ведению базы данных (набора данных)

И4

ИО

-

Х

Инструкция по эксплуатации КТС

ИЭ

ТО

-

Х

Схема соединений внешних проводок

С4*

ТО

Х

-

Допускается выполнять в виде таблиц

Схема подключения внешних проводок

С5*

ТО

Х

-

То же

Таблица соединений и подключений

С6

ТО

Х

-

Схема деления системы (структурная)

Е1*

ТО

-

-

Чертеж общего вида

ВО*

ТО

Х

-

Чертеж установки технических средств

СА

ТО

Х

-

Схема принципиальная

СБ

ТО

Х

-

Схема структурная комплекса технических средств

С1*

ТО

Х

-

План расположения оборудования и проводок

С7

ТО

Х

-

Описание технологического процесса обработки данных (включая телеобработку)

ПГ

ОО

-

Х

Общее описание системы

ПД

ОР

-

Х

Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистемы, систем)

ПМ*

ОР

-

-

Формуляр

ФО*

ОР

-

Х

Паспорт

ПС*

ОР

-

Х

*Документы, код которых установлен в соответствии с требованиями стандартов ЕСКД

Примечания.

  1. В таблице приняты следующие обозначения:
  2. Знак Х - обозначает принадлежность к проектно-сметной или эксплуатационной документации.
  3. Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений.

[из 1.3.1 ГОСТ 34.201-89]

Состав комплекта документов при инициативной разработке

Состав комплекта документов при инициативной разработке (см. «Определение целей и задач документирования») может быть существенно сокращен по сравнению с изложенным в табл. 2 п. 1.3.1 ГОСТ 34.201-89. Потребуется минимальный комплект, необходимый и достаточный для автоматизированной системы:

Техническое задание потребуется руководству ради того, чтобы знать, чем занята проектная команда. Или она просто так что-то делает, радиолюбительством занимается. Пояснительная записка - для выяснения, насколько точно и обоснованно выполняются требования ТЗ. Описание комплекса технических средств (желательно с чертежом общего вида в виде панорамных фотографий и детальных снимков) - из тех соображений, что при очередной инвентаризации придется отчитываться, где, что, кому и сколько. А на детальных снимках видны шильдики с серийными номерами, позволяющие оперативно найти, в какой стойке расположено искомое и быстро отчитаться при инвентаризации, см. рисунки.

- Сервер в стойке

Описание программного и информационного обеспечения вряд ли представляет интерес для руководителя, а вот описание оргструктуры - весьма и весьма. Из него можно выяснить, кто из проектной команды чем занят, насколько он загружен, с кем «коммуникирует» и т.д., а не задавать вопросы из серии «А что ты сделал из того, что должен был сделать?». При разрастании штата подразделения держать в голове функции всех и каждого, лично ставить задачи, отслеживать исполнение и т.д. становится затруднительно, несмотря на обилие программных средств руководства проектом.

- Шильдик сервера

При разработке изделия для собственных нужд достаточно инструкции по эксплуатации по ГОСТ 2.102-68. Если «собственные нужды» выходят за рамки одного подразделения предприятия - изделие разрабатывается, допустим, для соседнего отдела, - то следует подстраховаться и разработать минимальный комплект документов:

  • технические условия (ТУ по ГОСТ 2.102) - обязательно стребовать подпись с «заказчика»;
  • пояснительную записку (ПЗ по ГОСТ 2.102);
  • программу и методику испытаний (ПМ по ГОСТ 2.102) или, хотя бы, получить согласованный и утвержденный протокол испытаний;
  • какой-либо эксплуатационный документ по ГОСТ 2.601.

В ряде случаев могут дополнительно потребоваться чертежи, спецификации и т.д. Многое зависит, в конечном счете, от личных взаимоотношений руководителей подразделений. Чем лучше взаимоотношения, тем меньше бумаги придется плодить - В темных очках

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

Состав комплекта документов при иных видах разработки

При разработках в интересах заказчика состав комплекта документов может приближаться к реграментируемым соответствующими стандартами 2, 19, 24-й систем и 34-го комплекса, как показано в таблицах выше. При разработке в интересах «народно-хозяйственного» пользователя чаще всего достаточно единственного документа - руководства пользователя, см. «Как писать руководство пользователя? Часть I».