Выбор (уточнение) состава комплекта документов
admin
вкл пт, 23/12/2011 - 20:53
Выбор (уточнение) состава комплекта документов зависит от:
- предмета разработки (и документирования, разумеется) - изделия, программного изделия (программы), автоматизированной системы;
- целей и задач документирования (вида разработки).
Состав комплекта документов на изделие
Состав комплекта документов на изделия регламентирован ГОСТ 2.102-68.
Документы подразделяют на виды, указанные в таблице (ниже).
Вид документа | Код документа | Назначение документа |
Чертеж детали | - | Документ, содержащий изображение детали и другие данные, необходимые для ее изготовления и контроля |
Сборочный чертеж | СБ | Документ, содержащий изображение сборочной единицы и другие данные, необходимые для ее сборки (изготовления) и контроля. К сборочным чертежам также относят чертежи, по которым выполняют гидромонтаж и пневмомонтаж |
Чертеж общего вида | ВО | Документ, определяющий конструкцию изделия, взаимодействие его составных частей и поясняющий принцип работы изделия |
Теоретический чертеж | ТЧ | Документ, определяющий геометрическую форму (обводы) изделия и координаты расположения составных частей |
Габаритный чертеж | ГЧ | Документ, содержащий контурное (упрощенное) изображение изделия с габаритными, установочными и присоединительными размерами |
Электромонтажный чертеж | МЭ | Документ, содержащий данные, необходимые для выполнения электрического монтажа изделия |
Монтажный чертеж | МЧ | Документ, содержащий контурное (упрощенное) изображение изделия, а также данные, необходимые для его установки (монтажа) на месте применения. К монтажным чертежам также относят чертежи фундаментов, специально разрабатываемых для установки изделия |
Упаковочный чертеж | УЧ | Документ, содержащий данные, необходимые для выполнения упаковывания изделия |
Схема | По ГОСТ 2.701 | Документ, на котором показаны в виде условных изображений или обозначений составные части изделия и связи между ними |
Спецификация | - | Документ, определяющий состав сборочной единицы, комплекса или комплекта |
Ведомость спецификаций | ВС | Документ, содержащий перечень всех спецификаций составных частей изделия с указанием их количества и входимости |
Ведомость ссылочных документов | ВД | Документ, содержащий перечень документов, на которые имеются ссылки в конструкторских документах изделия |
Ведомость покупных изделий | ВП | Документ, содержащий перечень покупных изделий, примененных в разрабатываемом изделии |
Ведомость разрешения применения покупных изделий | ВИ | Документ, содержащий перечень покупных изделий, разрешенных к применению в соответствии с ГОСТ 2.124 |
Ведомость держателей подлинников | ДП | Документ, содержащий перечень предприятий (организаций), на которых хранят подлинники документов, разработанных и (или) примененных для данного изделия |
Ведомость технического предложения | ПТ | Документ, содержащий перечень документов, вошедших в техническое предложение |
Ведомость эскизного проекта | ЭП | Документ, содержащий перечень документов, вошедших в эскизный проект |
Ведомость технического проекта | ТП | Документ, содержащий перечень документов, вошедших в технический проект |
Пояснительная записка | ПЗ | Документ, содержащий описание устройства и принципа действия разрабатываемого изделия, а также обоснование принятых при его разработке технических и технико-экономических решений |
Технические условия | ТУ | Документ, содержащий требования (совокупность всех показателей, норм, правил и положений) к изделию, его изготовлению, контролю, приемке и поставке, которые нецелесообразно указывать в других конструкторских документах |
Программа и методика испытаний | ПМ | Документ, содержащий технические данные, подлежащие проверке при испытании изделий, а также порядок и методы их контроля |
Таблица | ТБ | Документ, содержащий в зависимости от его назначения соответствующие данные, сведенные в таблицу |
Расчет | РР | Документ, содержащий расчеты параметров и величин, например, расчет размерных цепей, расчет на прочность и др. |
Инструкция | И... | Документ, содержащий указания и правила, используемые при изготовлении изделия (сборке, регулировке, контроле, приемке и т. п.) |
Эксплуатационные документы | ||
РЭ | Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частей и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей | |
Инструкция по монтажу, пуску, регулированию и обкатке изделия | ИМ | Документ, содержащий сведения, необходимые для монтажа, наладки, пуска, регулирования, обкатки и сдачи изделия и его составных частей в эксплуатацию на месте его применения |
ФО | Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения, отражающие техническое состояние данного изделия, сведения о сертификации и утилизации изделия, а также сведения, которые вносят в период его эксплуатации (длительность и условия работы, техническое обслуживание, ремонт и другие данные) | |
ПС | Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, а также сведения о сертификации и утилизации изделия | |
ЭТ | Документ, содержащий гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения о сертификации и изделия | |
КДС | Документ, содержащий перечень деталей и сборочных единиц изделия с иллюстрациями и сведения об их количестве, расположении в изделии, взаимозаменяемости, конструктивных особенностях и материалах | |
НЗЧ | Документ, содержащий номенклатуру запасных частей изделия и их количество, расходуемое на нормируемое количество изделий в период их эксплуатации | |
НМ | Документ, содержащий номенклатуру материалов и их количество, расходуемое на нормируемое количество изделий в период их эксплуатации | |
Ведомость комплекта запасных частей, инструмента и принадлежностей (ЗИП) | ЗИ | Документ, содержащий номенклатуру, назначение, количество и места укладки запасных частей, инструментов, принадлежностей и материалов, расходуемых за срок службы изделия |
Учебно-технические плакаты | УП | Документы, содержащие сведения о конструкции изделия, принципах действия, приемах использования, техническом обслуживании, областях технических знаний с необходимыми иллюстрациями |
ВЭ | Документ, устанавливающий комплект эксплуатационных документов и места укладки документов, поставляемых с изделием или отдельно от него | |
Ремонтные документы по ГОСТ 2.602 |
|
|
[из п. 1.2 ГОСТ 2.102-68]
Состав комплекта документов на программу (программное изделие)
Состав комплекта документов на программу (программное изделие) регламентирован ГОСТ 19.101-77.
Виды программных документов и их содержание приведены в таблице (ниже).
Вид программного документа | Содержание программного документа |
Состав программы и документации на нее | |
Перечень предприятий, на которых хранят подлинники программных документов | |
Запись программы с необходимыми комментариями | |
Сведения о логической структуре и функционировании программы | |
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля | |
Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний | |
Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений | |
Сведения для обеспечения функционирования и эксплуатации программы |
[из п. 2.2 ГОСТ 19.101-77]
Виды эксплуатационных документов и их содержание приведены таблице (ниже).
Вид эксплуатационного документа | Содержание эксплуатационного документа |
Перечень эксплуатационных документов на программу | |
Основные характеристики программы, комплектность и сведения об эксплуатации программы | |
Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств | |
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения | |
Сведения для эксплуатации программы | |
Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы | |
Описание синтаксиса и семантики языка | |
Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
[из п. 2.3 ГОСТ 19.101-77]
Состав комплекта документов на автоматизированную систему
Состав комплекта документов на автоматизированную систему регламентирован ГОСТ 34.201-89.
Наименование конкретных документов, разрабатываемых при проектировании системы в целом или ее части, приведены в таблице (ниже).
Стадия создания | Наименование документа | Код документа | Часть проекта | Принадлежность к | Дополнительные указания | |
ПСД | ЭД | |||||
ЭП | ЭП* | ОР | - | - |
| |
П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 | ТО | Х | - |
| ||
Описание технологического процесса обработки данных (включая телеобработку) | ПГ | ОО | - | Х |
| |
ПД | ОР | - | Х |
| ||
Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистемы, систем) | ПМ* | ОР | - | - |
| |
ФО* | ОР | - | Х |
| ||
ПС* | ОР | - | Х |
| ||
*Документы, код которых установлен в соответствии с требованиями стандартов ЕСКД | ||||||
Примечания.
- В таблице приняты следующие обозначения:
- ЭП - эскизный проект;
- ТП - технический проект;
- РД - рабочая документация;
- ОР - общесистемные решения;
- ОО - решения по организационному обеспечению;
- ТО - решения по техническому обеспечению;
- ИО - решения по информационному обеспечению;
- ПО - решения по программному обеспечению;
- МО - решения по математическому обеспечению.
- Знак Х - обозначает принадлежность к проектно-сметной или эксплуатационной документации.
- Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений.
[из табл. 2 п. 1.3.1 ГОСТ 34.201-89]
Состав комплекта документов при инициативной разработке
Состав комплекта документов при инициативной разработке (см. «Определение целей и задач документирования») может быть существенно сокращен по сравнению с изложенным в табл. 2 п. 1.3.1 ГОСТ 34.201-89. Потребуется минимальный комплект, необходимый и достаточный для автоматизированной системы:
- техническое задание по ГОСТ 34.602;
- пояснительная записка (П2 по ГОСТ 34.201);
- описание комплекса технических средств (П9 по ГОСТ 34.201);
- описание программного обеспечения (ПА по ГОСТ 34.201);
- описание информационного обеспечения (П5 по ГОСТ 34.201);
- описание организационного обеспечения (ПВ по ГОСТ 34.201).
Техническое задание потребуется руководству ради того, чтобы знать, чем занята проектная команда. Или она просто так что-то делает. Пояснительная записка - для выяснения, насколько точно и обоснованно выполняются требования ТЗ. Описание комплекса технических средств (желательно с чертежом общего вида в виде «панорамных» фотографий и детальных снимков) - из тех соображений, что при очередной инвентаризации придется отчитываться, где, что и сколько. А на детальных снимках видны шильдики с серийными номерами, позволяющие оперативно найти, в какой стойке расположено искомое, и быстро отчитаться при инвентаризации, см. рисунки.
Описание программного и информационного обеспечения вряд ли представляет интерес для руководителя, а вот описание организационного - весьма и весьма. Из него можно выяснить, кто из проектной команды чем занят, насколько он загружен, с кем «коммуникирует» и т.д., а не задавать вопросы из серии «А что ты сделал из того, что должен был сделать?». При разрастании штата подразделения держать в голове функции всех и каждого, лично ставить задачи, отслеживать исполнение и т.д. становится затруднительно, несмотря на обилие программных средств руководства проектом.
При разработке изделия для собственных нужд достаточно инструкции по эксплуатации по ГОСТ 2.102-68. Если «собственные нужды» выходят за рамки одного подразделения предприятия - изделие разрабатывается, допустим, для соседнего отдела - то следует подстраховаться и разработать минимальный комплект документов:
- технические условия (ТУ по ГОСТ 2.102) - обязательно стребовать подпись с «заказчика»;
- пояснительную записку (ПЗ по ГОСТ 2.102);
- программу и методики испытаний (ПМ по ГОСТ 2.102) или, хотя бы, получить согласованный и утвержденный протокол испытаний;
- какой-либо эксплуатационный документ по ГОСТ 2.601.
В ряде случаев могут дополнительно потребоваться чертежи, спецификации и т.д. Многое зависит, в конечном счете, от личных взаимоотношений руководителей подразделений. Чем лучше взаимоотношения, тем меньше бумаги придется плодить 
Состав комплекта документов при инициативной разработке для программы выбирается из идеологических соображений, приведенных выше, только согласно ГОСТ 19.
Состав комплекта документов при иных видах разработки
При разработках в интересах заказчика состав комплекта документов может приближаться к реграментируемым соответствующими стандартами 2-й, 19-й, 24-й и 34-й систем, как показано в таблицах (выше). При разработке в интересах конечного пользователя чаще всего достаточно единственного документа - руководства пользователя, см. «Как писать руководство пользователя? Часть I».
Заказать услуги, установить контакты со специалистами компании можно по электронной почте admin собака tdocs точка su, по ICQ UIN 481-726-610 или с помощью формы «Контакты». Вопросы некоммерческого характера могут быть заданы в Форуме проектировщиков и разработчиков технической документации.
- Версия для печати
- 335 просмотров