[ «ПРИМЕНЕНИЕ ПОЛОЖЕНИЙ ТЕХНИЧЕСКОГО РЕГЛАМЕНТА для оформления конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и проектов Издательство МГТУ имени Н.Э. Баумана МОСКОВСКИЙ ...»
МОСКОВСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ
имени Н.Э. БАУМАНА
ПРИМЕНЕНИЕ
ПОЛОЖЕНИЙ ТЕХНИЧЕСКОГО РЕГЛАМЕНТА
для оформления конструкторско-технологической документации
при выполнении домашних заданий, курсовых работ и проектов
Издательство МГТУ имени Н.Э. Баумана
МОСКОВСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ
имени Н.Э. БАУМАНАПРИМЕНЕНИЕ
ПОЛОЖЕНИЙ ТЕХНИЧЕСКОГО РЕГЛАМЕНТА
для оформления конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и проектов Москва Издательство МГТУ имени Н.Э. Баумана УДК 621.396. ББК 32. Рецензент:Заведующий кафедрой ГОУ ВПО «Московский авиационный институт» (ТУ) д-р техн. наук, проф. В.А. Назаров А.Е.Аверьянихин, А.И.Власов, Л.В.Журавлева, Л.А.Зинченко, В.А.Соловьев
ПРИМЕНЕНИЕ ПОЛОЖЕНИЙ ТЕХНИЧЕСКОГО РЕГЛАМЕНТА для
оформления конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и проектов / под ред.В.А.Шахнова. - М.: МГТУ им. Н.Э. Баумана, 2011. - 53 с.: ил.
В учебном пособии представлены рекомендации по применению положений технического регламента для оформления конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и проектов. Приведены пояснения базовых требований, предъявляемых к оформлению конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и проектов по направлению «Конструирование и технология производства ЭС».
Для студентов приборостроительных специальностей.
Ил. 39. Табл. 5. Библиогр. 7 назв.
УДК 621.396. ББК 32. © МГТУ им. Н.Э. Баумана,
СОДЕРЖАНИЕ
Нормативные документыСписок условных обозначений, сокращений и терминов
Введение
1 МАРШРУТЫ ПРОЕКТИРОВАНИЯ ЭС
1.1 Основные понятия конструкторско-технологического документооборота............ 1.2 Техническая документация
1.3 Единая система конструкторской документации (ЕСКД)
1.4 Единая система технологической документации (ЕСТД)
1.5 Схемная документация
2 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ КОНСТРУКТОРСКО-ТЕХНОЛОГИЧЕСКИХ
ДОКУМЕНТОВ2.1 Общие требования к практическим работам
2.2 Типовые маршруты проектирования электронных средств и систем
2.3 Общие требования к стилю оформления документации
2.4 Общие требования к оформлению библиографии
2.5 Содержание и оформление графической части
3 ОБЩИЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ИСХОДНОГО КОДА
ПРОГРАММНЫХ СИСТЕМ3.1 Общие положения
3.2 Общие требования к исходному коду программных систем на Java
3.3 Общие требования к исходному коду программных систем на SQL
Список использованных источников
Приложение А. Бланки
НОРМАТИВНЫЕ ДОКУМЕНТЫ
При разработке использованы следующие нормативные документы:Закон Российской Федерации «Об образовании» (в редакции Федерального закона от 13.01.1996 г. №12-ФЗ);
Федеральный закон «О высшем и послевузовском профессиональном образовании»
(от 01.12.2007 г. № 125-ФЗ, от 24.10.2007 № 232-ФЗ, от 01.12.2007 № 307-ФЗ, № 308ФЗ, № 309-ФЗ, № 313-ФЗ);
ГОСТ Р ИСО 9001-2001. Система менеджмента качества. Требования;
Типовое положение об образовательном учреждении высшего профессионального образования (высшем учебном заведении), утвержденное постановлением Правительства РФ от 14 февраля 2008 г. N 71;
Приказ Рособрнадзора №1938 от 30.09.2005 г. «Об утверждении показателей деятельности и критериев государственной аккредитации высших учебных заведений»;
Приказ Минобразования РФ «О комплексной оценке деятельности высшего учебного заведения» (№ 864 от 12.11.1999 г.);
Письмо Заместителя руководителя Рособрнадзора от 17.04.2006 г. № 02-55-77 ин/ак (Учебно-методические комплексы);
Положение об организации учебного процесса в МГТУ им. Н.Э. Баумана от 01.06.2000 г.;
Закон Российской Федерации «О техническом регулировании» (в редакции Федерального закона от 27 декабря 2002 г. N 184-ФЗ с изменениями от 8 августа г., 1 мая, 1 декабря 2007 г., 23 июля 2008 г.);
ГОСТ 7.1-84 «Система стандартов по информации, библиотечному и издательскому делу. Библиографическое описание документа. Общие требования и правила составления».
СПИСОК УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СОКРАЩЕНИЙ И ТЕРМИНОВ
Комплекс мероприятий по организации и методическому обеспечению Методическая учебного процесса в виде совокупности следующих процессов:деятельность по разработка программы дисциплины для определенного учебного плана и ее дисциплине регулярная корректировка в установленном порядке;
организация и методическое обеспечение практических (семинарских) организация и методическое обеспечение лабораторных работ;
организация и методическое обеспечение самостоятельной работы обеспечение студентов учебниками, учебными пособиями и учебнометодической литературой по дисциплине;
обеспечение студентов электронными учебными материалами по обеспечение учебного процесса лабораторным оборудованием и методическое обеспечение применяемых инновационных методов и контроль и организация методического обеспечения по дисциплине.
Учебно-методический Совокупность регламентирующих документов, учебных материалов и материально-технической базы по конкретной дисциплине и сведений, комплекс характеризующих условия реализации учебного процесса по данной дисциплине; является частью основной образовательной программы высшего образовательного стандарта; создается с целью оптимизации содержания обучения, повышения качества и эффективности проведения занятий по дисциплине, написания качественных учебников, учебных пособий и учебнометодической литературы и входит в состав контролируемых нормативных документов кафедры. УМК состоит из методического, материальнотехнического, информационного, методического, обучающего (содержательного) и контролирующего обеспечений.
Основной методический компонент по дисциплине, содержащий:
Программа дисциплины междисциплинарный характер или связанные с задачами воспитания;
содержание дисциплины, структурированное по видам учебных занятий с учебно-методическое обеспечение дисциплины, включая перечень основной и дополнительной литературы, методические рекомендации (материалы) преподавателю и методические указания студентам;
Материалы, устанавливающие содержание и порядок проведения текущего Регламент контроля контроля успеваемости и промежуточной аттестации студентов по данной компетенций дисциплине, должны формироваться с учетом действующего «Положения об Крупная часть учебной программы, имеющая определенную функциональную и Блок дисциплин логическую завершенность по отдельному направлению области компетенций по отношению к установленным целям и результатам обучения, воспитания.
Логически завершенная часть учебной программы, состоящая из совокупности Модуль дисциплин Модуль дисциплины завершенность по отношению к установленным целям и результатам обучения, Программа, соответствующая требованиям ГОС ВПО и учитывающая Программа специфику подготовки студентов по избранному направлению или дисциплины Печатное или электронное издание, содержащее систематическое изложение Учебник учебной дисциплины, соответствующее программе и официально утвержденное в качестве данного вида издания. Основное средство обучения. Учебник является центральной частью учебного комплекса и содержит материал, Учебное издание, официально утвержденное в качестве данного вида издания, Учебное пособие частично заменяющее, или дополняющее учебник. Учебные пособия предназначены для расширения, углубления и улучшения усвоения знаний, предусмотренных программами и изложенных в учебнике. Кроме того, учебные пособия выпускают по вновь создаваемым курсам или курсам по выбору.
Материал, подготовленный с целью организации самостоятельной работы Курс лекций студентов. В нем на основе преподавательского конспекта лекций полностью рассмотрено содержание дисциплины. Курс лекций обычно является авторской работой, в которой возможно рассмотрение конкретных проблем, спорных Комплекс материалов представляемых в виде приложения к программе Методические дисциплины и должны указывать на средства и методы обучения, способы рекомендации учебной деятельности студентов, применение которых для освоения тех или Комплекс материалов, раскрывающих рекомендуемый режим и характер Методические различных видов учебной работы по данной дисциплине, в том числе указания для запланированных видов самостоятельной работы студентов (СРС).
студентов Материал, который освещает содержание дисциплины в наиболее обобщенной, Конспект лекций компактной форме, предоставляя студентам лишь самую существенную информацию. Обычно готовится по новой дисциплине или в дополнение к учебнику. Как правило, в нем рассматривают новые проблемы, раскрывают альтернативные решения, характеризуют оригинальные направления развития отрасли, конкретных объектов техники или разделов науки.
Домашнее задание – это индивидуальная форма учебной деятельности Домашнее задание обучаемого, которая осуществляется им самостоятельно по заданию преподавателя и направлено на закрепление материалов части (блока) курса.
Курсовая работа – это индивидуальная практическая форма учебной Курсовая работа деятельности обучаемого, которая осуществляется им самостоятельно по заданию преподавателя и направлено на выполнение практического задания по Технический регламент в Российской Федерации – документ (нормативный Технический правовой акт), устанавливающий обязательные для применения и исполнения регламент требования к объектам технического регулирования (продукции, в том числе зданиям, строениям и сооружениям, процессам производства, эксплуатации,
ВВЕДЕНИЕ
Опыт развития мировой экономики показывает, что эффективными подходами, обеспечивающими создание конкурентоспособной и высококачественной продукции, являются принципы стандартизации и сертификации [1, 2].Особенно роль стандартизации и сертификации возрастает в условиях рыночной экономики. На современном этапе фирмы, производящие продукцию, и фирмы, являющиеся дистрибьюторами произведенной продукции, с целью обеспечения возможности выхода на рынок и достижения конкурентоспособности должны выполнять следующие условия [1, 2, 4]:
выполнять обязательные требования к качеству продукции, установленные техническим законодательством;
удовлетворять требованиям к качеству продукции, рекомендованным подтверждать соответствие обязательным и рекомендуемым требованиям к качеству продукции и системам обеспечения качества сертификатами и декларациями соответствия.
Нормативные документы (техническое законодательство, стандарты, сертификаты (декларации) соответствия) являются законодательной базой для технического регулирования.
Техническое регулирование – это правовое регулирование в трех областях:
техническое законодательство, стандартизация, оценка соответствия.
Под регулированием понимаются действия государства по организации поведения хозяйствующих субъектов на рынке с помощью установленных норм и правил.
Основными механизмами государственного регулирования взаимодействия различных хозяйствующих субъектов являются стандартизация, метрология и оценка соответствия.
Федеральное агентство по техническому регулированию и метрологии (Росстандарт) входит в систему федеральных органов исполнительной власти Российской Федерации и находится в ведении Министерства промышленности и торговли Российской Федерации. Федеральное агентство по техническому регулированию и метрологии является федеральным органом исполнительной власти, осуществляющим функции по оказанию государственных услуг, управлению государственным имуществом в сфере технического регулирования и метрологии. До внесения изменений в законодательные акты Российской Федерации Федеральное агентство по техническому регулированию и метрологии осуществляет лицензирование деятельности по изготовлению и ремонту средств измерений, а также функции по государственному метрологическому контролю и надзору. Федеральное агентство осуществляет также контроль и надзор за соблюдением обязательных требований государственных стандартов и технических регламентов.
Одним из основополагающих нормативных правовых актов, использующихся в техническом регулировании, является Федеральный закон «О техническом регулировании» N 184-ФЗ [1]. Этот закон устанавливает принципы технического регулирования в Российской Федерации.
В Федеральном законе «О техническом регулировании» N 184-ФЗ технический регламент определяется следующим образом:
Технический регламент – документ, который принят международным договором Российской Федерации и ратифицирован в порядке, установленном законодательством Российской Федерации, или межправительственным соглашением, заключенным в порядке, установленном законодательством Российской Федерации, или федеральным законом, или указом Президента Российской Федерации, или постановлением Правительства Российской Федерации, и устанавливает обязательные для применения и исполнения требования к объектам технического регулирования (продукции, в том числе зданиям, строениям и сооружениям, или к связанным с требованиями к продукции процессам проектирования (включая изыскания), производства, строительства, монтажа, наладки, эксплуатации, хранения, перевозки, реализации и утилизации).
Технический регламент должен содержать:
исчерпывающий перечень продукции и процессов жизненного цикла продукции (ЖЦП), а именно: производство, эксплуатации, хранения, перевозки, реализации, в отношении которых устанавливаются требования технического регламента;
правила идентификации объекта технического регулирования (идентификация продукции - это установление тождественности характеристик ее существенным минимально необходимые требования, обеспечивающие безопасность продукции и правила и формы оценки соответствия (в том числе схемы подтверждения соответствия);
предельные сроки оценки соответствия в отношении каждого объекта технического регулирования;
требования к терминологии, упаковке, маркировке или этикеткам и правила их В соответствие с этим законом в Российской Федерации действуют общие технические регламенты и специальные технические регламенты.
Обязательные требования к отдельным видам продукции, процессам производства, эксплуатации, хранения, перевозки, реализации и утилизации определяются совокупностью требований общих технических регламентов и специальных технических регламентов.
Требования общего технического регламента обязательны для применения и соблюдения в отношении любых видов продукции, процессов производства, эксплуатации, хранения, перевозки, реализации и утилизации.
Требованиями специального технического регламента учитываются технологические и иные особенности отдельных видов продукции, процессов производства, эксплуатации, хранения, перевозки, реализации и утилизации.
Технические регламенты должны базироваться на научно-обоснованных данных;
должны быть сформулированы и должны применяться таким образом, чтобы не создавать произвольных и ненужных препятствий в международной торговле. Технические регламенты должны применяться на основе режима наибольшего благоприятствования и не должны быть более обременительными для импортных товаров, чем для товаров национального производства.
Федеральные образовательные стандарты третьего поколения устанавливают высокие требования к уровню профессиональной компетенции выпускников в области стандартизации. В частности, выпускники по направлению 211000 «Конструирование и технология электронных средств» должны обладать следующими профессиональными компетенциями в области технического регулирования:
готовностью осуществлять контроль соответствия разрабатываемых проектов и технической документации стандартам (ТР, ГОСТ, ОСТ, ТУ, РУК, СТП, нормалям и другим нормативным документам);
готовностью выполнять задания в области сертификации технических средств, систем, процессов и материалов.
В данном пособии содержатся основные положения технического регламента, определяющего требования к оформлению конструкторско-технологической документации при выполнении домашних заданий, курсовых работ и курсовых проектов в процессе подготовки компетентных специалистов по направлению «Конструирование и технология производства ЭС».
1 МАРШРУТЫ ПРОЕКТИРОВАНИЯ ЭС
1.1 Основные понятия конструкторско-технологического документооборота Маршрут проектирования (design flow) – это последовательность этапов и процедур для проектирования объекта. Маршруты для групп процессов могут быть одинаковыми (типовыми). Структура и состав маршрута проектирования во многом определяют содержание конструкторско-технологической документации (в частности, например, расчетно-пояснительной записки (РПЗ)). Именно изучение и применение маршрутов проектирования является главным предметом специальной подготовки студента.Потребность – задание на проект формулируется в виде исходного описания системы, ее базовых желаемых функциональных свойств.
Результат проектирования – пакет документации, необходимой для многократного и повторяемого изготовления изделия.
Проектирование – это процесс, заключающийся в преобразовании исходного описания в окончательное на основе выполнения процедур системотехнического, конструкторского, технологического и исследовательского характера.
Конструкторско-технологическая документация занимает определенное место в процессе производственной деятельности на границе разделяемых функций исполнения.
Конструкторско-технологический документ это инструмент распределения функций между работниками.
Документ – это совокупность трех составляющих:
физическая регистрация информации;
форма представления информации;
активизация определенной деятельности.
Именно некоторая деятельность и превращает информацию в документ. Но документ перестает существовать, если в дальнейшем не подразумевает процедуры обработки. При этом форма документа тесно связана с характером дальнейшей деятельности, она порождает необходимость документов.
Собственно документооборот может быть двух типов:
универсальный – автоматизирующий существующие информационные потоки слабоструктурированной информации. Справедливо было бы его называть аморфным или беспорядочным документооборотом;
операционный – ориентированный на работу с документами, содержащими слабоструктурированной информации.
Государственными стандартами и техническими регламентами определен единый порядок разработки и постановки на производство продукции технического назначения, в том числе и ЭА. В частности, государственным стандартом ГОСТ 2.103-68 установлены следующие основные стадии разработки:
техническое предложение (ТП);
эскизный проект (ЭП);
технический проект (ТП).
Основой для разработки является техническое задание (ТЗ), содержание которого устанавливает ГОСТ 15.001-73. В ТЗ излагаются назначение и область применения разрабатываемой ЭА, технические, конструктивные, эксплуатационные и экономические требования к ЭА, условия по ее хранению и транспортированию, требования по надежности, правила проведения испытаний и приемки образцов в производстве.
На стадии технических предложений (ГОСТ 2.118-73) производится анализ существующих технических решений, патентные исследования, проработка возможных вариантов создания ЭА, выбор оптимального решения, макетирование отдельных узлов ЭА, выработка требований для последующих этапов разработки.
На стадии эскизного проектирования (ГОСТ 2.119-73) проводится конструкторская и технологическая проработка выбранного варианта реализации ЭА; изготавливается действующий образец или серия ЭА; проводятся их испытания в объеме, достаточном для подтверждения заданных в техническом задании технических и эксплуатационных параметров; организуется разработка в полном объеме необходимой конструкторской документации, которой присваивается литера «Э»; прорабатываются основные вопросы технологии изготовления, наладки и испытания элементов, узлов, устройств и ЭА в целом.
На стадии технического проекта (ГОСТ 2.120-73) принимаются окончательные решения о конструктивном оформлении ЭА и составляющих ее узлов, разрабатывается полный комплект конструкторской и технологической документации, которой присваивается литера «Т», изготавливается опытная серия ЭА, проводятся испытания ЭА на соответствие заданным в ТЗ техническим и эксплуатационным требованиям.
Результаты технического проектирования являются основой для разработки полного комплекта рабочей конструкторской документации, которой присваивается литера «О».
В последующем осуществляется технологическая подготовка производства, выпуск установочной серии и организация серийного (массового) выпуска ЭА.
Стадии разработки технического задания, разработки технических предложений и эскизное проектирование включаются, как правило, в научно-исследовательскую работу (НИР), а стадии разработки технического проекта и технологической подготовки производства – в опытно-конструкторскую разработку (ОКР).
В последние годы применительно к продукции технического назначения используется термин жизненный цикл, под которым понимаются все этапы создания изделия, начиная с разработки ТЗ и кончая эксплуатацией готовых изделий. Жизненный цикл ЭС, разделенный на этапы ее разработки, изготовления и эксплуатации, представлен на рисунке 1.1. Здесь к эскизному проектированию можно отнести этапы 1…6, к техническому проекту – этапы 7…19. Затенены на рисунке 1.1 те этапы, полное или частичное выполнение которых зависит от участия в их выполнении конструкторов и технологов.
Рисунок 1.1 – Обобщенный маршрут жизненного цикла изделий электронной техники Все вышесказанное относится к вновь создаваемой ЭА, основанной на использовании принципиально новых технических решений. В последние годы в связи с развитием предприятий, специализирующихся на разработке и производстве отдельных узлов и устройств ЭА, появилась возможность существенного сокращения трудовых и временных затрат на создание крупносерийных или массовых изделий (так называемые сборочная или «отверточная» технология). В этом случае разработчикам ЭА необходимо тщательно подобрать комплектующие изделия, чтобы созданная ими аппаратура была технологичной в изготовлении, удобной в эксплуатации и конкурентоспособной, а так же выполнить ряд работ, предусмотренных схемой на рисунке 1.1., например, выпуск документации, проведение испытаний и т.д.
1.2 Техническая документация На всех этапах жизненного цикла (разработка – производство – эксплуатация) ЭА сопровождает техническая документация (ТД). Состав этой документации и ее содержание регламентируется Государственными стандартами (ГОСТ) и техническими регламентами (ТР). В настоящее время в стране действуют большое количество стандартов и регламентов, которые сгруппированы по направлениям жизненного цикла изделий в следующие комплексы:
Единая система конструкторской документации (ЕСКД);
Единая система технологической документации (ЕСТД);
Единая система программной документации (ЕСПД);
Единая система технологической подготовки производства (ЕСТПП);
Единая система защиты изделий и материалов от коррозии, старения и биоповреждений (ЕСЗКС);
Основная задача стандартизации: обеспечить единую нормативно-техническую, информационную, методическую и организационную основу проектирования, производства и эксплуатации изделий. При этом обеспечивается использование единого технического языка и терминологии, взаимообмен документацией между предприятиями без ее переоформления, совершенствование организации проектных работ, возможность автоматизации разработки технической документации с унификацией машинноориентированных форм документов, совершенствование способов учета, хранения и изменения документации и др.
Основой дальнейшей информатизации является привязка к «коду документа» – уникальному для каждого документа условному цифро-буквенному коду, однозначно идентифицирующему любую разработку в рамках как одного предприятия, так и всей отрасли и т.д. Аналогом «кода документа» в банковской системе является «лицевой счет», единственный и уникальный в своем роде. Документ, как и лицевой счет, может изменяться, т.е. находиться в динамике, эти изменения для лицевого счета оформляются платежными поручениями, а для конструкторского документа - ведомостями изменений.
На рисунке представлен пример для введения «кодов документа» для организации кафедрального документооборота, кода документов на уровне предприятий и отраслей определяются соответствующими нормативными документами. Один раз, реализовав привязку к коду документа, в дальнейшем мы всегда имеем возможность полностью проследить всю иерархию зависимых документов и всю их динамику. Этим достигается главное требование к современным информационным системам – однократность ввода информации.
ИУ4 ИУ 2205 00. 00. 00. ХХ Рисунок 1.2 – Принципы формирования кодов (децимальных номеров) конструкторскотехнологических документов (чертеж детали и спецификация в обозначении документа не Кроме «кода документа», конструкторско-технологические документы характеризуются набором базовых показателей (опять же аналог с платежным поручением), которые объединены и представлены в так называемом «штампе». «Штамп»
– это своего рода визитная карточка конкретного документа, причем четко формализованная. Вид «штампа» для чертежей и схем показан на рисунке 1.3 а), для текстовых документов на рисунке б), а на рисунке в) – штамп для последующих листов чертежей схем и текстовых документов. Нетрудно заметить, что для каждой записи в штампе (некой таблице) отводится строго определенная ячейка и это уже напоминает реляционный (табличный) подход, остается один шаг для создания реляционной базы данных, но не все так просто.
Выдачу децимальных номеров для организаций осуществляет ФГУП «Стандартинформ» (http://www.vniiki.ru/). Для присвоения четырехзначного буквенного кода организации-разработчика (проекта) в соответствии с ГОСТ 2.201-80 “Единая система конструкторской документации. Обозначение изделий и конструкторских документов” необходимо направить в адрес ФГУП «Стандартинформ», в котором указать:
название продукции, класс по ЕСКД, желаемый код, реквизиты организации, юр. адрес, почтовый адрес, банковские реквизиты.
Рисунок 1.3 – Примеры заполнения штампа конструкторско-технологических документов Назначение граф штампа чертежей по ГОСТ:
Графа 1 – наименование изделия (в соответствии с требованиями ГОСТ 2.109-73).
Графа 2 – обозначение графической части работы в соответствии с Приложением Графа 3 – обозначение материала детали (графу заполняют только на чертежах деталей).
Графа 4 – литера, присвоенная данному документу по ГОСТ 2.103-68 (графу заполняют последовательно, начиная с крайней левой клетки).
Графа 5 – масса изделия по ГОСТ 2.109-73.
Графа 6 – масштаб (проставляют в соответствии с ГОСТ 2.302-68 и ГОСТ 2.109Графа 7 – порядковый номер листа (на документах, состоящих из одного листа, эту графу не заполняют).
Графа 8 – общее число листов документа (графу заполняют только на первом листе).
Графа 9 – наименование университета и учебной группы.
Графа 10 – характер работы, выполняемой лицом, подписывающим документ.
Графа 11 – фамилии лиц, подписавших документ.
Графа 12 – подписи лиц, фамилии которых указаны в графе 11.
Графа 13 – дата подписания документа.
Графы 14-18 – данные из граф таблицы изменений, которые заполняют в соответствии с требованиями ГОСТ 2.503-74.
Технический документ характеризуется уникальным «кодом документа» и основная информация по его принадлежности и основным параметрам сведена в «штамп».
Но кроме этого, в зависимости от вида информации, наполнение документа может быть различным и что самое важное – слабоформализованным и тут начинаются основные сложности на пути его представлении в электронном виде в рамках единой информационной системы. Сразу же надо отметить, что техническая документация может быть подразделена на две большие группы – тестовые документы и графические. Пока вопросы автоматической обработки графических документов рассматривать не будем (т.е.
информация из штампа графического документа и т.д. для нас закрыта, к вопросам параметрического проектирования мы вернемся позднее). Остановимся на вопросах обработки текстовых документов, а графические будем рассматривать как отдельные «законченные» файлы данных, обработка внутреннего содержания которых проходит вне информационной системы на отдельных рабочих местах.
1.3 Единая система конструкторской документации (ЕСКД) Государственные стандарты, входящие в ЕСКД, устанавливают взаимосвязанные единые правила и положения по порядку разработки, оформления и обращения конструкторской документации на изделия, разрабатываемые и выпускаемые предприятиями всех отраслей промышленности.
Конструкторские документы (КД) – графические и текстовые документы, в отдельности или в совокупности, определяющие состав и устройство изделия, и содержащие необходимые данные для его разработки и изготовления, контроля, приемки, эксплуатации и ремонта.
Стандартам ЕСКД присваиваются обозначения на основе классификационного принципа. Номер стандарта составляется из цифры 2, присвоенной классу стандартов ЕСКД, одной цифры после точки, обозначающей классификационную группу стандартов в соответствии с таблицей 1.1, числа, определяющего порядковый номер стандарта в данной группе, и двузначной цифры (после тире), указывающей год регистрации стандарта. Например, обозначение стандарта ЕСКД «ЕСКД. Схемы. Виды и типы. Общие требования к выполнению» имеет вид: ГОСТ 2.701-84, то есть ГОСТ – категория нормативно-технического документа (государственный стандарт), 2 – класс (стандарты ЕСКД), 7 – классификационная группа стандартов, 01 – порядковый номер стандарта в группе, 84 – год регистрации стандарта.
Таблица 1.1 – Классификационные группы стандартов в ЕСКД Шифр группы 0 Общие положения.
1 Основные положения.
2 Классификация и обозначение изделий в КД.
3 Общие правила выполнения чертежей.
4 Правила выполнения чертежей изделий машиностроения и приборостроения.
5 Правила обращения КД (учет, хранение, дублирование, внесение изменений).
6 Правила выполнения эксплуатационной и ремонтной документации.
7 Правила выполнения схем.
8 Правила выполнения документов строительных, судостроительных и горных дел.
9 Прочие стандарты.
К графическим конструкторским документам относятся:
чертеж детали – изображение детали и другие данные, необходимые для ее изготовления и контроля.
сборочный чертеж (СБ) – изображение сборочных единиц и другие детали, необходимые для сборки и контроля.
чертеж общего вида (ВО) – определяет конструкцию изделия, взаимодействие его основных частей и поясняет принцип работы изделия.
теоретический чертеж (ТЧ) – геометрическая форма (обводы) изделия и координаты расположения основных частей.
габаритный чертеж (ГЧ) – контурное изображение изделия с габаритными, установочными и присоединительными размерами.
электромонтажный чертеж (ЭМ) – данные для электрического монтажа изделия.
монтажный чертеж (МЧ) – контурное изображение изделия и данные для его установки на месте применения.
установочный чертеж (УЧ) – данные для установки изделия.
схема – составные части изделия в виде условных изображений или обозначений и связи между ними.
К текстовым конструкторским документам относятся:
спецификация – определяет состав сборочной единицы, комплекса, комплекта.
ведомость спецификаций (ВС) – перечень всех спецификаций составных частей изделия с указанием их количества и входимости.
ведомость ссылочных документов (ВД) – перечень документов, на которые имеются ссылки в кд на изделие.
ведомость покупных изделий (ВП) – перечень покупных изделий, примененных в разрабатываемом изделии.
ведомость разрешений применения покупных изделий (ВИ) – перечень покупных изделий, разрешенных к применению по гост 2.124-85.
ведомость держателей подлинников (ДП) – перечень организаций-хранителей подлинников примененных в изделии документов.
ведомость технического предложения (ВТ) – перечень документов, вошедших в техническое предложение.
ведомость эскизного проекта (ЭП) – перечень документов, вошедших в эскизный ведомость технического проекта (ТП) – перечень документов, вошедших в технический проект.
пояснительная записка (ПЗ) – описание устройства и принципа действия разработанного изделия, а так же обоснование разработки.
технические условия (ТУ) – требования к изделию, его изготовлению, контролю качества, приемке и поставке.
программа и методика испытаний (ПМ) – технические данные, подлежащие проверке при испытании изделия, порядок и методы их контроля.
таблица (ТБ) – данные, сведенные в таблицу.
расчет (РР) – расчеты параметров и величин, например, расчет размерных цепей, расчет на прочность, расчет теплового режима и др.
эксплуатационные документы – документы для использования при эксплуатации, обслуживании и ремонте изделия в процессе эксплуатации.
ремонтные документы – данные для проведения ремонтных работ на специализированных предприятиях.
инструкция (И) – указания и правила, используемые при изготовлении изделия (сборке, регулировке, контроле и т.п.).
патентный формуляр (ПФ) – документ, содержащий результаты патентного поиска, осуществленного при разработке изделия. в нем содержится оценка патентоспособности, патентная чистота и технический уровень разработанного изделия, материала, процесса, метода.
1.4 Единая система технологической документации (ЕСТД) Государственные стандарты, входящие в ЕСТД, устанавливают взаимосвязанные единые правила и положения по порядку разработки, оформления и обращения технологической документации, разрабатываемой и применяемой на предприятиях всех отраслей промышленности страны.
Рисунок 1.4 – Классификация технологических документов Рисунок 1.5 – Стадии разработки технологических документов Технологические документы (ТД) – текстовые и графические документы, в отдельности или в совокупности определяющие порядок изготовления изделия, проведения процессов и содержащие необходимые данные для контроля и приемки изделий.
Так же, как в ЕСКД стандартам ЕСТД присваиваются обозначения на основе классификационного принципа. Номер стандарта составляется из цифры 3, присвоенной классу стандартов ЕСТД, одной цифры после точки, обозначающей подкласс (цифра 1 для изделий машино- и приборостроения), одной цифры, соответствующей классификационной группе стандартов в соответствии с таблицей 1.2, числа, определяющего порядковый номер стандарта в данной группе, и двузначной цифры (после тире), указывающей год регистрации стандарта. Например, обозначение стандарта «ЕСТД. Правила оформления документов контроля. Журнал контроля технологического процесса» имеет вид: ГОСТ 3.1505-75, то есть ГОСТ – категория нормативнотехнического документа (государственный стандарт), 3 – класс (стандарты ЕСТД), 1 – изделие машино- или приборостроения, 5 – классификационная группа стандартов, 05 – порядковый номер стандарта в группе, 75 – год регистрации стандарта.
Таблица 1.2 – Классификационные группы стандартов в ЕСТД Шифр группы 0 Общие положения.
1 Основополагающие стандарты.
2 Классификация и обозначение технологических документов.
3 Учет применяемости деталей и сборочных единиц в изделиях и средств технологического оснащения.
4 Основное производство. Формы технологических документов и правила их оформления на процессы, специализированные по видам работ.
5 Основное производство. Формы документов и правила их оформления на испытания и контроль.
6 Вспомогательное производство. Формы технологических документов и правила 7 Правила заполнения технологических документов.
9 Информационная база.
Виды и правила проектирования технологической документации определяются видом производства, на котором будут изготовляться или ремонтироваться изделия и его составные части. В машино- и приборостроении в зависимости от назначения производства можно разделить на основное, вспомогательное и опытное. Основное производство – производство товарной продукции, вспомогательное – производство средств, необходимых для обеспечения функционирования основного производства.
Опытное производство служит для изготовления образцов, партий и серий изделий при проведении научно-исследовательских работ.
По типу производства разделяются на единичное, серийное и массовое.
По организации производства разделяют на поточное, групповое и установившееся.
По уровню применяемых средств автоматизации и механизации производства разделяют на автоматизированное и механизированное.
По виду или признаку применяемого метода для изготовления (ремонта) изделия производства подразделяются на: литейное, прессовое, механообрабатывающее, термическое, сборочное, сварочное, гальваническое, лакокрасочное, полупроводниковое, вакуумное и др.
Стадии разработки технологической документации определяются стадиями разработки конструкторской документации на изделие и соответствуют схеме, приведенной на рисунке 1.2. Отметим, что на конструкторской стадии «Техническое предложение» технологическая документация не разрабатывается, на конструкторских стадиях «Эскизный проект» и «Технический проект» технологическая документация имеет стадию «Предварительный проект». В отдельных отраслях промышленности применяется «Директивная технологическая документация», предназначенная не для изготовления, а для выполнения предварительных расчетов различного рода задач в целях определения возможности размещения соответствующего заказа на ом или ином предприятии. Задачи при этом могут быть инженерно-техническими, плановоэкономическими, организационными.
Так как объем технологической документации при производстве изделий достаточно велик, все виды технологических документов классифицируются по назначению, по носителю информации, по виду вносимой информации, по принципу построения и по специализации (рисунок 1.3.).
Основные технологические документы могут нести различную информацию:
о комплектующих составных частях изделия и применяемых материалах;
о действиях, выполняемых исполнителями при проведении технологических процессов и операций;
о средствах технологического оснащения производства;
о наладке средств технологического оснащения и применяемых данных по технологическим режимам;
по расчету трудозатрат, материалов и средств технологического оснащения;
по технологическому маршруту изготовления и ремонта;
о требованиях к рабочим местам, экологии окружающей среды и т.п.
Основные технологические документы используются, как правило, на рабочих местах. Вспомогательные технологические документы разрабатываются с цель улучшения и оптимизации организации работ по технологической подготовке производства. Производные технологические документы применяются для решения задач, связанных с нормированием трудозатрат, выдачей и сдачей материалов, полуфабрикатов и комплектующих изделий.
Применяются следующие виды технологических документов:
Ведомость технологических маршрутов (ВТМ) – сводная информация по технологическому маршруту изготовления изделия и его составных частей.
Ведомость материалов (ВМ) – сводные подетальные нормы расхода материалов (основных и вспомогательных) на изделие.
Ведомость специфицированных норм расхода материалов (ВСН) – сводные данные по специфицированным нормам расхода материалов на изделие.
Ведомость удельных норм расхода материалов (ВУН) – удельные нормы расхода материалов, применяемых при выполнении процессов на покрытия.
Ведомость применяемости деталей (сборочных единиц) в изделии (ВП) – указания о применяемости деталей (сборочных единиц) в изделии.
Ведомость применяемости стандартных, покупных, оригинальных деталей и сборочных единиц (ВП/СОП) – то же, что и ВП.
Ведомость сборки изделия (ВП/ВСИ) – порядок сборки изделия с учетом очередности входимости составных частей и их количества.
Технологическая ведомость (ТВ) – указания по группированию деталей и сборочных единиц по конструкторско-технологическим или технологическим Ведомость технологических документов (ВТД) – полный состав технологических документов, применяемых при изготовлении изделия.
Ведомость оснастки (ВО) – полный состав технологической оснастки, применяемой при изготовлении (ремонте) изделия.
Ведомость оборудования (ВОБ) – полный состав оборудования, применяемого при изготовлении (ремонте) изделия.
Технологическая инструкция (ТИ) – описание часто повторяющихся приемов работы, действий по наладке и настройке средств технологического оснащения, приготовлению растворов, электролитов, смесей и др., а так же отдельных типовых и групповых технологических процессов (операций).
Маршрутная карта (МК) – сводные данные по составу применяемых операций, оборудованию, технологических документов и по трудозатратам на технологический процесс.
Операционная карта (ОК) – операционное описание единичных технологических Паспорт технологический (ТП) – комплекс выполняемых процедур по выполнению технологических операций исполнителями, технологическому контролю, контролю представителями заказчика или госприемки.
Журнал контроля технологического процесса (ЖКТП) – предназначен для контроля параметров технологических режимов, применяемых при выполнении операций на соответствующем оборудовании.
Полный перечень видов технологических документов, а так же их формы и правила построения можно найти в соответствующем ГОСТе.
1.5 Схемная документация В общем объеме документации, выпускаемой в процессе разработки изделий, в том числе ЭА, существенное место занимает схемная документация.
Схема – графическая конструкторская документация, на которой показаны в виде условных изображений или обозначений составные части изделия и связи между ними.
Схемы применяются при изучении принципа действия механизма, прибора, аппарата при их изготовлении, наладке и ремонте, для понимания связи между составными частями изделия без уточнения особенностей их конструкции. Схемы являются исходным базисом для последующего конструирования отдельных частей и всего изделия в целом. По виду элементов, входящих в состав изделия, связей между ними и назначения схемы подразделяют на виды (табл. 1.3) и типы (табл. 1.3). В соответствии с обозначениями, приведенными в таблицах, устанавливается код схемы. Так схема Э3 – схема электрическая принципиальная, схема К2 – схема кинематическая функциональная и т.д.
Таблица 1.3 – Виды и типы схем Наименование схемы Обозначение Наименование схемы Обозначение Составляющими частями схем являются:
элемент схемы – составная часть схемы, которая не может быть разделена на части, имеющие самостоятельное значение (микросхема, резистор, трансформатор и устройство – совокупность элементов, представляющая единую конструкцию (блок, модуль). в ряде случаев устройство может не иметь определенного функционального назначения;
функциональная группа – совокупность элементов, выполняющих определенную функцию и не объединенных в единую конструкцию;
функциональная часть – элемент, устройство или функциональная группа, имеющие строго определенное функциональное назначение;
функциональная цепь – линия, канал на схеме, указывающие на наличие связи между функциональными частями изделия;
линия взаимосвязи – отрезок линии на схеме, указывающий на наличие связи между функциональными частями изделия;
линия электрической связи – линия на схеме, указывающая путь прохождения тока, сигнала и др.
при проектировании ЭА используются следующие виды схем:
структурные схемы (Э1), определяющие основной состав ЭА и ее функциональные части, их назначение и взаимосвязи. структурные схемы разрабатывают на начальных стадиях проектирования ЭА, их используют как для разработки схем других типов, так и для общего ознакомления с ЭА.
функциональные схемы (Э2), поясняющие процессы, происходящие в отдельных функциональных частях и узлах ЭА. функциональные схемы являются основой для разработки принципиальных схем и применяются при наладке, ремонте и эксплуатации ЭА.
принципиальные схемы (Э3), определяющие полный состав элементов и связей между ними и дающие полное представление о принципе работы отдельных узлов и устройств ЭА. принципиальные схемы являются основой для разработки полного комплекта конструкторской документации на ЭА.
схемы соединений (Э4), показывающие соединения составных частей ЭА и определяющие провода, жгуты, кабели и другие соединительные изделия, а так же места их присоединения и ввода. схемы соединений используются как при выпуске кд на ЭА, так и при ее ремонте и эксплуатации.
схемы подключений (Э5), показывающие внешние подключения ЭА. эти схемы используются при монтаже ЭА на месте эксплуатации и при ее ремонте.
общие схемы (Э6), определяющие составные части ЭА и соединения их между собой на месте эксплуатации.
схемы расположения (Э7), устанавливающие взаимное расположение отдельных устройств ЭА, а так же соединяющих их жгутов, кабелей и т.д.
при проектировании схем любых видов необходимо придерживаться правил, изложенных в соответствующих стандартах. так для схем цифровой техники схемы электрические выполняются по правилам, установленным гост 2.708-81 с использованием условных графических обозначений (УГО), выполняемых по гост 2.743-82 и гост 2.721-74.
Рисунок 1.6 - Разметка поля чертежа элемента, а высоту ряда – основной минимальной высоте УГО. Обозначение зоны состоит из обозначения ряда и обозначения колонки, например, С03, К12.
Электрические связи с входными выводами показывают входящими линиями листа схемы, начиная с левой стороны или сверху листа. Связи с выходящими выводами показывают выходящими линиями, заканчивая их на правой стороне или внизу листа.
Условные графические обозначения элементов строятся на основе прямоугольника.
В общем виде УГО может содержать основное и два дополнительных поля (рисунок 1.7).
Размер прямоугольного поля по ширине зависит от наличия дополнительных полей и числа, помещенных в них знаков (меток, обозначения функций элемента), по высоте – от числа выводов, интервалов между ними и числа строк информации в основном и дополнительных полях. Согласно стандарту ширина основного поля должна быть не менее 10 мм, дополнительных – не менее 5 мм (при большом числе знаков в метках и обозначении функций элемента эти размеры соответственно увеличивают), расстояние между выводами – 5 мм, между выводом и горизонтальной стороной обозначения – не менее 2,5 мм и кратно этой величине. При разделении групп выводов интервалом величина последнего должна быть не менее 10 мм и кратна 5 мм.
Выводы элементов делятся на входы, выходы, двунаправленные выводы и выводы, не несущие информации. Входы изображают слева, выходы справа, остальные выводы – с любой стороны УГО. При необходимости разрешается поворачивать УГО на 900 по часовой стрелке, располагая входы сверху, а выходы внизу.
Функциональное назначение элемента указывают в верхней части основного поля УГО. Его составляют из прописных букв латинского алфавита, арабских цифр и знаков, записываемых без пробела (число знаков в обозначении функции не ограничивается).
Обозначения основных функций приведены в таблице 1.4.
Таблица 1.4 – Обозначения основных логических элементов Усилитель мощности В дополнительных полях условного графического обозначения элементов цифровой техники дается информация о функциональных назначениях выводов, указатели, метки, обозначения которых приведены в таблице 1.5.
Таблица 1.5 – Обозначение выводов Указатель питания цифровой Вывод для подключения:
Для указания сложной функции допускается построение составной метки, образованной из основных меток. Например, функция «данные контрольные»
отображается как DSO, «разрешение записи» – ERD, «строб считывания» – RDM.
Допускается в качестве меток вывода применять обозначения функции, порядковый номер, а так же весовые коэффициенты разрядов. Для нумерации разрядов в группах выводов к обозначению метки добавляют номера разрядов.
Позиционное обозначение элемента схемы в общем случае состоит из вида, номера и функции элемента, записываемых подряд. Вид и номер элемента являются обязательной частью его буквенно-цифрового обозначения и присваивается всем элементам и устройствам. Буквенные коды групп элементов схем приведены в таблице 1.6.
Таблица 1.6 – Буквенные коды групп элементов Устройства коммута- S В качестве примера на рисунке 1.6 приведен фрагмент схемы электрической принципиальной, выполненной на интегральных микросхемах.
Рисунок 1.7 – Фрагмент схемы электрической принципиальной Правила разработки схем электрических других видов электронной аппаратуры определяются соответствующими стандартами. Каждый из элементов схемы может быть описан на специальном языке и храниться со специализированной базе данных, но пока, как и в случае с графическими документами, будем рассматривать схемы в виде законченных документов, изменение внутреннего содержимого которых средствами информационной системы невозможно.
2 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ КОНСТРУКТОРСКОТЕХНОЛОГИЧЕСКИХ ДОКУМЕНТОВ
2.1 Общие требования к практическим работам Практические работы (расчетные, домашние задания, курсовые работы и проекты) состоят из пояснительной записки, графической части и созданного работающего макета (прототипа системы).Расчетно-пояснительная записка (РПЗ), объемом 50-70 страниц (для КР, КП без учета спецификаций и приложений) и 30-40 страниц (для ДЗ без учета спецификаций и приложений), оформляется согласно требованиям технического регламента, составленного с учетом требований ГОСТ 7.32-91 (ИСО 5966-82) «Отчет о научноисследовательской работе. Структура и правила оформления».
В соответствии с этим стандартом текстовый документ подобного типа должен включать:
титульный лист (Приложение А);
задание (Приложение А);
календарный план (Приложение А);
реферат (аннотацию на 2 языках);
список условных обозначений, сокращений и терминов;
содержание;
введение;
основная часть;
заключение;
список используемых источников;
приложения.
После титульного листа, бланка задания и бланка календарного плана для курсовой работы (проекта) вшивается расширенное техническое задание на разрабатываемую систему (модель), разработанное согласно ГОСТ, и расширенный календарный план работ, представленный в виде таблицы и диаграммы Ганта.
В связи со спецификой учебной документации по согласованию с руководителем работы допускается ряд отклонений от требований государственных стандартов и регламентов, которые должны быть указаны в бланке задания.
Все материалы практических работ сдаются поэтапно, в строгом соответствии с календарным планом, о чем делается соответствующая отметка. Нарушение сроков сдачи этапов практических работ влечет снижение итоговой оценки. Календарным планом курсовой работы (проекта) предусматриваются 2 аттестации. В случае неаттестации студентом в срок оценка снижается на 1 балл.
Студенты, не подписавшие (получившие) задание на практическую работу на момент ее сдачи, указанном в календарном плане, считаются не приступившими к практическому заданию. Им выдается новое задание, и они направляются на повторное обучение.
Все материалы РПЗ и графическая часть сдаются в твердой копии на бумажном носителе и в электронном варианте на CD носителе (структура каталогов диска: doc – документация, source – исходные коды, install – инсталляционный комплект, img – чертежи и схемы, ppt – презентации, source_doc – источники разработки), CD в конверте крепится к задней обложке пояснительной записки. Все файлы электронного варианта называются латинскими буквами, каждый раздел РПЗ в отдельном файле (01_titul.doc, 02_zadanie.doc, 03_kal_pan.doc, 04_annot.doc, 05_soder.doc, 06_vvedenie.doc, 07_glava_1.doc и т.п.). Текстовая часть РПЗ представляется в формате *.doc и *.pdf, графическая в формате используемого САПРа и *.pdf.
2.2 Типовые маршруты проектирования электронных средств и систем Титульный лист выполняется в соответствии с Приложением А и является первым листом пояснительной записки. На второй странице размещается задание, оформленное согласно Приложению А. На третьей странице – календарный план выполнения практической работы (Приложение А). После данных листов вшивается расширенное техническое задание и расширенный календарный план (для курсовой работы или проекта), выполненный в виде диаграммы Ганта (данные документы не входят в РПЗ и нумеруются отдельно).
Аннотация выполняется на двух языках – русском и иностранном (выбор иностранного языка осуществляется разработчиком). В аннотации указывается цель выполненной работы, методы решения конструкторских, технологических, исследовательских задач и полученные результаты. Краткое изложение содержания работы. Из которой можно понять содержание выполненной работы без прочтения всего материала. Аннотация пишется в один абзац и размещается на следующей странице после титульного листа.
Если по заданию предусматривается разработка расширенного технического задания, то оно подготавливается согласно требованиям стандартов и вшивается после аннотации бланка задания и бланка календарного плана и нумеруется как отдельный документ.
На основе анализа расширенного технического задания разрабатывается календарный план выполнения проекта (КР, ДЗ) согласно Приложению 3 и уточненный календарный план в виде диаграммы Ганта. Пример оформления календарного плана в виде диаграммы Ганта представлен на рисунке 2.1.
Список условных обозначений, сокращений и терминов оформляется согласно ГОСТ 7.32-91 (ИСО 5966-82).
В состав проекта могут быть включены документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения, которые оформляются в соответствии с требованиями ЕСПД и соглашением и разработке ПО. Виды и комплектность программных документов установлены ГОСТ 19.101-77.
Состав и комплектность документов, входящих в практическую работу, согласуются с руководителем работы и вносятся в бланк задания.
Во введении дается обоснование выбора темы проекта и его место в научнотехническом направлении, в рамках которого выполняется работа. Определяется актуальность темы, ее практическая ценность, формулируется цель работы и решаемые задачи. Указываются области применения работы в промышленности или научных исследованиях.
Введение должно быть структурировано и включать следующие базовые (выделяемые «жирным» текстом) элементы: актуальность исследований, цель работы, методы исследований, научная новизна работы, достоверность полученных результатов, положения, выносимые на защиту, практическая ценность работы, реализация результатов, апробация работы, публикации, структура и объём работы, ожидаемые результаты.
В разделе «Анализ задания» приводится расширенное техническое задание (только для КР), анализируется исходная информация на проектирование и разработку. В разделе определяются задачи, методы их решения, определяются источники информации, которые будут использоваться, и применяемые технические средства.
Основная часть РПЗ формируется на основе анализа маршрутов проектирования (см. таблицы 2.1–2.4).
В заключении подводится итог выполненного задания, как по содержанию, так и по объему, формулируются рекомендации по практическому применению результатов исследований и проектирования.
В списке использованных источников должна быть представлена использованная при выполнении работы учебная и научно-техническая литература, государственные, отраслевые стандарты и технические условия. Список используемой литературы оформляется в соответствии с требованиями ГОСТ 7.1- «Библиографическое описание документа».
В приложении приводятся спецификации к схемам, маршрутные и операционные карты, технологические инструкции, ведомости технологической оснастки, инструментов и материалов, листинги разработанных программ и т.п. Все материалы графической части работы, выполненные на формате А3, также должны быть представлены в приложении.
Каждое приложение следует начинать с нового листа с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ», написанного заглавными буквами. Приложение должно иметь содержательный заголовок. Если в расчетно-пояснительной записке более одного приложения, их следует нумеровать последовательно буквами, например, ПРИЛОЖЕНИЕ А и т.д. Текст каждого приложения при необходимости может быть разделен на подразделы и пункты. Рисунки, таблицы и формулы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения, например:
«Рисунок А.1» (первый рисунок приложения А); «Таблица А.1» (первая таблица первого приложения).
Уточненный календарный план в виде диаграммы Ганта вшивается после расширенного технического задания и нумеруется как отдельный документ.
Таблица 2.1 – Типовой маршрут проектирования электронной аппаратуры (диплом, курсовой проект)
СПИСОК УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СОКРАЩЕНИЙ И ТЕРМИНОВ
ВВЕДЕНИЕ
1 ОБЩЕТЕХНИЧЕСКОЕ ОБОСНОВАНИЕ РАЗРАБОТКИ
1.1 Анализ задания на проектирование 1.2 Анализ существующих схемных и конструкторских решений 1.2.2 Технико-экономическое обоснование целесообразности разработки Выводы2 СХЕМОТЕХНИЧЕСКОЕ ПРОЕКТИРОВАНИЕ
2.1 Разработка электрической функциональной или структурной схемы 2.2 Выбор и обоснование элементной базы 2.3 Расчет отдельных фрагментов электрической принципиальной схемы 2.4 Анализ принципа работы средства и выдача рекомендаций к разработке конструкции 2.5 Анализ временных диаграмм модуля (блока) Выводы3 РАЗРАБОТКА КОНСТРУКЦИИ
3.1 Разработка конструкции модуля 3.1.1 Предварительная компоновка 3.1.2 Выбор и обоснование конструкционных материалов и покрытий 3.1.3 Выбор и обоснование электрических соединений и разъемов 3.1.4 Обеспечение нормального теплового режима 3.1.5 Обеспечение защиты от механических воздействий 3.1.6 Обеспечение электромагнитной совместимости 3.1.7 Окончательная компоновка 3.2 Конструкторские расчеты 3.2.2 Расчет теплового режима 3.2.3 Расчет электромагнитной совместимости 3.2.4 Расчет на механические воздействия 3.2.5 Расчет показателей качества Выводы4 ТЕХНОЛОГИЧЕСКОЕ ПРОЕКТИРОВАНИЕ
4.1 Конструкторско-технологический анализ 4.1.1 Определение типа производства 4.1.2 Анализ технологичности средства с учетом типа производства 4.1.3 Расчет конструкторско-технологических параметров печатного монтажа с проверкой по постоянному и переменному току 4.1.4 Рекомендации к разработке технологического процесса 4.2 Разработка технологического процесса 4.2.1 Анализ типовых технологических процессов 4.2.2 Разработка технологического процесса сборки 4.2.3 Технологические расчеты по обоснованию разрабатываемого технологического процесса 4.3 Разработка технологической оснастки 4.3.1 Анализ существующей технологической оснастки и рекомендации по применению стандартного технологического оснащения 4.3.2 Разработка недостающего технологического оснащения 4.3.3 Конструкторско-технологический расчет технологического 4.4 Разработка средств контроля (настройки, испытаний) 4.4.1 Анализ существующих средств контроля (настройки, испытаний) 4.4.2 Разработка электрической схемы средства контроля (настройки) 4.4.3 Разработка конструкции средства контроля (настройки, испытания) Выводы5 ИССЛЕДОВАНИЯ РЕЖИМОВ (ХАРАКТЕРИСТИК)
5.1 Структура и состав экспериментального стенда 5.2 Разработка программы испытаний и экспериментальных исследований 5.3 Разработка методик испытаний и экспериментальных исследований 5.4 Оценка результатов испытаний и экспериментальных исследований ВыводыЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
Таблица 2.2 – Типовой маршрут проектирования аппаратно-программных комплексов (дипломная работа, квалификационная работа бакалавра, диссертация магистра)СПИСОК УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СОКРАЩЕНИЙ И ТЕРМИНОВ
ВВЕДЕНИЕ
1 ИССЛЕДОВАНИЕ ПРЕДМЕТНОЙ ОБЛАСТИ
1.1 Актуальность, области применения, постановка задачи 1.2 Анализ прототипов (литературных источников) 1.3 Анализ результатов патентных исследований 1.4 Классификация и систематизация знаний по данной предметной области 1.5 Выявленные проблем предметной области и пути их решения Выводы2 МАТЕМАТИЧЕСКИЕ МЕТОДЫ И МОДЕЛИ
2.1 Анализ методов 2.2 Анализ моделей 2.3 Разработка алгоритмов 2.4 Оценка результатов математического моделирования Выводы3 ПРОЕКТИРОВАНИЕ ВИДОВ ОБЕСПЕЧЕНИЙ ПРОГРАММНО-ТЕХНИЧЕСКОГО
КОМПЛЕКСА
Структура данного раздела может быть дана и согласно методике RUP см. табл.2.2. 3.1 Лингвистическое обеспечение 3.2 Алгоритмическое обеспечение 3.3 Информационное обеспечение 3.4 Программное обеспечение 3.4.1 Исследование и обоснование выбора общесистемного ПО 3.4.2 Лингвистическое обеспечение (обоснование выбора среды и средств разработки) 3.4.3 Разработка прикладного ПО 3.4.4 Генерация инсталляционного комплекта 3.4.4.1 Листинг инсталляционного комплекта модуля 3.4.4.2 Листинг инсталляционного комплекта модуля 3.5 Аппаратное обеспечение 3.6 Методическое обеспечение 3.6.1 Руководство оператора 3.6.2 Руководство технолога 3.6.3 Руководство администратора 3.7 Юридическое обеспечение Выводы 4 Экспериментальные исследования 6.1 Структура и состав экспериментального стенда 6.2 Программа (план) эксперимента 6.3 Разработка методик экспериментальных исследований (тестирования) 6.4 Оценка результатов экспериментальных исследований 6.5 Рекомендации по использованию полученных результатов ВыводыЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
Таблица 2.3 – Типовой маршрут структурно-функционального анализа при проектировании производственных процессов (Дз, курсовая работа)СПИСОК УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СОКРАЩЕНИЙ И ТЕРМИНОВ
ВВЕДЕНИЕ
1 РАЗРАБОТКА СТРУКТУРНО-ФУНКЦИОНАЛЬНОЙ МОДЕЛИ
ТЕХНОЛОГИЧЕСКОГО ПРОЦЕССА
1.1 Разработка контекстной диаграммы 1.2 Первый уровень декомпозиции - 1.3 Второй уровень декомпозиции - 1.3.1 Входной контроль и комплектация элементов 1.3.2 Подготовка элементов к установке 1.3.4 Выходной контроль изделия 1.4 Третий уровень декомпозиции Формовка и обрезка выводов 1.4.2 Подготовка перемычек 1.5 Разработка иерархической диаграммы (взвешенного графа) ТП Выводы2 ИССЛЕДОВАНИЯ ТП ИЗГОТОВЛЕНИЯ
2.1 Оптимизация по UDP-критерию 2.2 Проведение оптимизации по временному и стоимостному критерию разработанного технологического процесса 2.2.1 Оптимизация по времени 2.2.1 Оптимизация по стоимости 2.3 Выработка рекомендаций по улучшению ТП, разработка диаграмм альтернативных точек зрения Выводы3. ПРОЕКТИРОВАНИЕ ИНФОРМАЦИОННОЙ МОДЕЛИ
3.1 Выявление объектов модели 3.2 Разработка словарей сущностей и атрибутов 3.3 Проверка полноты словарей атрибутов и сущностей, привязка элементов информационной модели к элементам функциональной модели 3.4 Разработка логической информационной модели модуля 3.5 Разработка физической информационной модели модуля 3.6 Листинг SQL кода модуля ВыводыЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
Таблица 2.4 – Типовой маршрут проектирования информационной системы компьютерного сопровождения жизненного цикла изделий (курсовая работа)СПИСОК УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СОКРАЩЕНИЙ И ТЕРМИНОВ
ВВЕДЕНИЕ
1 СТРУКТУРНО-ФУНКЦИОНАЛЬНАЯ МОДЕЛЬ ПРОИЗВОДСТВЕННОГО
ПРОЦЕССА
1.1 Контекстная диаграмма 1.2 Первый уровень декомпозиции 1.3 Разработка иерархической диаграммы (взвешенного графа) 1.4 Спецификация ролей пользователей системы Выводы2 МОДЕЛИ ВАРИАНТОВ ИСПОЛЬЗОВАНИЯ И ДЕЯТЕЛЬНОСТИ
2.1 Диаграмма вариантов использования 2.2 Диаграмма последовательности действий прецедента 2.3 Диаграмма состояний модуля 2.4 Диаграмма кооперации для прецедента Выводы3 ЛОГИЧЕСКАЯ МОДЕЛЬ
3.1 Диаграмма пакетов 3.2 Диаграмма классов типа сущность модуля 3.3. Диаграмма классов модуля 3.4. Алгоритм работы модуля Выводы4 МОДЕЛЬ РЕАЛИЗАЦИИ
4.1 Диаграмма компонентов модуля 4.2 Диаграмма компонентов модуля Выводы5 МОДЕЛЬ РАЗВЁРТЫВАНИЯ
5.1 Архитектура комплекса 5.2 Диаграмма развертывания Выводы6 ГЕНЕРАЦИЯ ИНСТАЛЛЯЦИОННОГО КОМПЛЕКТА
6.1 Листинг инсталляционного комплекта модуля 6.2 Листинг инсталляционного комплекта модуля7 МЕТОДИЧЕСКОЕ ОБЕСПЕЧЕНИЕ
7.1 Руководство оператора 7.2 Руководство технолога 7.2 Руководство администратора Выводы8 ТЕСТИРОВАНИЕ
8.1 Методика тестирования 8.2 Результат тестирования ВыводыЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
Аннотация, введение, разделы пояснительной записки, заключение, список использованных источников, содержание и каждое приложение должны начинаться с новой страницы.Разделы пояснительной записки должны иметь порядковые номера, обозначенные арабскими цифрами без точек в конце. Подразделы должны иметь порядковые номера в пределах каждого раздела. Номера подразделов состоят из номеров раздела и подраздела, разделенных точкой. Подразделы при необходимости разбиваются на пункты (нумерация аналогична подразделам с присвоением пунктам номеров в пределах подраздела). Разделы «Аннотация», «Введение», «Заключение», «Список использованных источников», «Приложения» в содержании и тексте не нумеруются. Каждый раздел пояснительной записки должен заканчиваться выводом.
Заголовки разделов пишутся заглавными буквами и выравниваются по центру.
Рекомендуется любые заголовки выделять жирным начертанием. Заголовки подразделов записываются со стандартным абзацным отступом строчными буквами (кроме первой заглавной). Переносы слов в заголовках не допускаются. Точка в конце заголовка не ставится. Если заголовок состоит из двух предложений, их разделяют точкой.
Подчеркивать заголовки не следует.
Расстояние между заголовком и последующим текстом 1 строка, а между последней строкой текста и последующим заголовком 1-2 строки.
Сокращение слов в тексте и подписях под иллюстрациями не допускается, кроме установленных ГОСТ 7.12-77.
Изложение содержания должно быть кратким, четким, исключающим возможность субъективного толкования. Терминология и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии общепринятой в научно-технической литературе.
Для большей наглядности в пояснительной записке должны приводиться различные иллюстрации: рисунки, фотографии, схемы, диаграммы и т.п., которые выполняются по ГОСТ 2.105-79 и ГОСТ 2.319-81. Иллюстрации должны быть расположены по тексту пояснительной записки, возможно ближе к соответствующим частям текста.
При необходимости под иллюстрацией помещают пояснительные данные (подрисуночный текст). Иллюстрации нумеруются арабскими цифрами, например:
Рисунок 2.15 – Схема электрическая принципиальная.
На электрических схемах около каждого элемента должны быть приведены его позиционные обозначения в соответствии с требованиями ГОСТ 2.702-72.
2.3 Общие требования к стилю оформления документации Текст РПЗ печатается на русском языке через 1,5 интервала (для учебных работ рекомендуется через 1 интервал).
Высота букв, цифр и других знаков не менее 1,8 мм (кегль не менее 12). Для текста в таблицах кегль не менее 10. Размеры полей: правое – не менее 10 мм, левое – не менее 20 мм (но не более 30 мм), верхнее и нижнее – не менее 20 мм.
Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты различной гарнитуры:
«жирный», «курсив», «подчеркнутый».
Запрещается использовать встроенные стили электронных редакторов, средства автоматического генерирования содержания и нумерации рисунков.
Необходимо соблюдать равномерную плотность, контрастность и чёткость материалов по всему документу.
Правила написания даты: 10.04.2010. Допускается 2010.04.10.
Подписи, даты подписания и исправления – чёрным цветом или тушью.
Нумерация страниц – сквозная на весь документ, в центре нижней части листа, арабской цифрой, без точки.
Основной текст РПЗ рекомендуется оформлять шрифтом Times New Roman (кегль 12), в схемах и рисунках может применяться Arial (кегль 10-12), в формулах должен использоваться стандартный шрифт редактора формул и наборы символов.
При формировании списков левый отступ списка равен стандартному абзацному отступу, маркер списка (обязательно короткое тире, не дефис) располагается снаружи списка. Вторая и последующие строчки должны быть выравнены по ширине текста.
Величина абзацного отступа от 1 до 1.5 см (рекомендуется 1.25 см).
Использование расстановки переносов при подготовке текста РПЗ запрещено.
Титульный лист включается в общую нумерацию страниц РПЗ. Номер страницы на титульном листе не проставляют.
После аннотации отдельной строкой должен следовать перечень ключевых слов прописными буквами (от 5 до 15 слов или словосочетаний, в именительном падеже, через запятую).
Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами и записывать с абзацного отступа.
Разделы, подразделы должны иметь заголовки. Заголовки должны четко и кратко отражать содержание разделов, подразделов. Заголовки разделов, подразделов и пунктов следует печатать с абзацного отступа с прописной буквы без точки в конце, не подчеркивая.
Внутри пунктов или подпунктов могут быть приведены перечисления.
Перед каждым элементом перечисления следует ставить дефис или короткое тире.
При необходимости ссылки в тексте РПЗ на один из элементов перечисления вместо дефиса ставятся строчные буквы в порядке русского алфавита.
Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставятся скобки, а запись производится с абзацного отступа.
Нумерация приложений – буквенная: А, Б, В … Нумерация иллюстраций, таблиц, формул – сквозная или по разделам, арабскими цифрами:
Номер рисунка и его наименование располагают под рисунком посредине строки под поясняющими данными (подрисуночным текстом).
Иллюстрации приложений:
Горизонтальное расположение рисунков допускается по тексту РПЗ, вертикально расположенные рисунки должны располагаться на отдельных страницах (или в приложении), при этом подрисуночная подпись также располагается «вертикально» – вдоль длинной стороны листа.
Номер таблицы и её наименование помещают над таблицей слева, без абзацного отступа в одну строку с ее номером через тире.
Каждый раздел РПЗ следует начинать с новой страницы. Изложение материала в структурном элементе РПЗ не может начинаться с таблицы или рисунка. Сначала должен идти текст, в котором дается ссылка на рисунок или таблицу (рисунок 1.1), а после следовать рисунок (таблица). Многократная ссылка на рисунок оформляется следующим образом: см. рисунок 1.1. по тексту документа. Заканчиваться любой структурный элемент РПЗ также должен текстом, содержащим выводы по данному структурному разделу.
Ссылки на использованные источники – в квадратных скобках [1] (ГОСТ 7.1-84).
Уравнения и формулы – в отдельную строку. Выше и ниже формулы оставляют по одной свободной строке. Если формула не умещается на одну строку, то она переносится по математическим знакам равенства (=), плюса (+), минуса (-), умножения () и других, причём знак в начале следующей строки повторяется. После формулы ставится запятая, после которой ниже пишется «где» и даётся пояснение каждого символа.
Расчеты в общем случае должны содержать: эскиз изделия или схему, данные для расчета, задачу расчета, расчет и выводы по расчету.
Условные буквенные обозначения механических, химических, математических и других величин, а также условные графические обозначения должны соответствовать требованиям, предъявляемым к технической документации. В тексте документа перед обозначением параметра дают его название.
В формулах в качестве символов следует применять обозначения, установленные соответствующими стандартами.
Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой в той же последовательности, в какой они даны в формуле. Значение каждого символа и числового коэффициента следует давать с новой строки.
Расчетные формулы должны записываться в общем виде. Затем в формулы подставляются значения входящих параметров в той последовательности, в какой они приведены в формулах, и, наконец, приводится результат вычисления.
Формулы в пояснительной записке нумеруются в пределах всей записки цифрами в круглых скобках в крайнем правом положении на строке.
Ссылки на формулы указываются порядковым номером формулы в круглых скобках, например, «… в формуле (1.1)».
Рекомендуется при написании формул использовать электронные редакторы формул (вставлять формулы в виде изображений запрещено). Все требования к оформлению формул в этом случае остаются такими же, как и при оформлении формул вручную.
Единицы физических величин – в системе СИ (ГОСТ 8.417-2002). Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной.
Единицы информации: КБ, МБ, ГБ.
Таблица 2.5 – Рекомендуется использовать следующие сокращения слов (ГОСТ 7.12-93) инж.
Таблица 2.6 – Правила записи и округления округление:
132,48 = 132, Числовой диапазон:
от 1 до 5 мм;
Список использованных источников – сведения об источниках следует располагать в порядке появления ссылок на источники в тексте РПЗ и нумеровать арабскими цифрами без точки и печатать с абзацного отступа.
2.4 Общие требования к оформлению библиографии При подготовке практических работ (расчетных, домашних заданий, курсовых работ и проектов) даются ссылки на используемую литературу, стандарты, технические условия и другие документы.
Ссылаться следует на документ в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций практической работы.
Ссылки на используемую литературу даются в тексте в соответствии с логической необходимостью в квадратных скобках арабскими цифрами.
При ссылках на стандарты и технические условия указывают только их обозначение, при этом допускается не указывать год их утверждения при условии полного описания стандарта в списке использованных источников в соответствии с ГОСТ 7. 1 [4].
В списке использованных источников сведения об источниках следует располагать в порядке появления ссылок на источники в тексте отчета и нумеровать арабскими цифрами без точки и печатать с абзацного отступа.
Сведения об источниках приводятся в соответствии с требованиями ГОСТ 7.1- «Система стандартов по информации, библиотечному и издательскому делу.
Библиографическое описание документа. Общие требования и правила составления».
Библиографическое описание состоит из элементов, объединенных в области, и заголовка. Элементы и области приводят в последовательности, установленной в перечнях стандарта. Отдельные элементы и области могут повторяться.
Библиографические сведения, относящиеся к разным элементам, но грамматически связанные в одном предложении, записывают в предшествующем элементе.
Элементы библиографического описания подразделяют на обязательные и факультативные.
Обязательные элементы обеспечивают идентификацию документа. Их приводят в любом библиографическом описании при наличии соответствующих сведений в источнике библиографического описания.
Общий для группы библиографических описаний обязательный элемент, вынесенный в название раздела или в заглавие информационного издания, в описании опускают.
Факультативные элементы дают дополнительную информацию о документе (его содержании, читательском назначении, иллюстративном материале и т. п.).
Каждой области библиографического описания, кроме первой, предшествует знак точка и тире ( — ), который заменяют точкой, если область выделена шрифтом или записана с новой строки.
Если первый элемент области отсутствует, точку и тире ставят перед последующим элементом, разделительный знак которого в этом случае опускают.
Пример оформления библиографического описания на книгу:
количество авторов не более трех:
Сидоров И.В. Исследование процессов. - М.: Радиосвязь, 1987. - 341 с.
авторов не более четырех:
Конструирование ЭА: учебное пособие / И. И. Сидоров, П. П. Иванов, С. С.
Петров, Е.М.Волков. - М.: Изд-во МГТУ им.Н.Э.Баумана, 1983. – 120 с.
авторов более четырех:
Сотрудничество / И. И. Петров, П. П. Иванов, С. С. Дубинин и др: АН СССР.
ИПМ. - Киев; Наук. думка, 1983. - 370 с.
Пример оформления библиографического описания статьи в журнале (серийном издании):
авторов не более трех:
Сидоров И. И., Иванов П. П., Петров С. С. Исследование процессов эволюции // Изв. РАН. Сер. "М". – 1986, № 10. - С. 61-65.
А.И.Власов, С.Г.Семенцов, Ю.А.Поляков Микропроцессорные системы активной индивидуальной акустозащиты // Микросистемная техника. – 2000, №2. - С.-15-20.
авторов не более четырех:
Исследование процессов эволюции / И. И. Петров, П. П. Иванов, С. С. Дубинин, Е. К. Фомин // МТИ, сер.14. – 1995, № 1. - С.61-76.
авторов более четырех:
Исследование процессов эволюции / И. И. Петров, П. П. Иванов, С. С. Дубинин и др. // Вест. МГТУ им.Н.Э.Баумана. Сер. Приборостроение. - 2005. - Том 1; № 2. - С.21-24.
Пример оформления библиографического описания статьи в книге и сборнике:
Исследование процессов эволюции / И. И. Сидоров, Е. И. Зайцев // Эволюция и мозг: Сборник научн. трудов ИППИ. - М., 2001. - Вып.10 - С.12-15.
Сидоров В.И. Разрушение пластмасс // Надежность ЭА: учебное пособие / И. И.
Петров, П. П. Иванов, С. С. Дубинин и др. - М., 2004. - С.164-166.
В.А. Барат, А.И.Власов, Д.А.Гомонов, Д.В.Подобедов Применение методов МКЭ и МГЭ при сеточном моделировании объектов типа среда-структура // Сборник научных трудов. 10-ая Молодежная научно-техническая конференция "Наукоемкие технологии и интеллектуальные системы". - Москва. 16-17 марта 2000 г.- С.130-145.
Пример оформления рукописей (рукопись - это различные документы, тираж которых менее 500 экз.):
Иванов А.А. Технологический процесс изготовления электронного репеллента // РПЗ к курсовой работе по курсу ТПЭС – М.: МГТУ им. Н.Э.Баумана, 25 ноября 2010. – с. (рукопись).
Пример оформления ссылок на интернет источники:
Грекул В.И. Проектирование информационных систем. – Электронный ресурс.
Режим доступа: http://www.intuit.ru/department/se/devis/. - Проверено 08.12.2010.
Указывать в качестве ссылок на источники адреса сайтов без уточнения адреса конкретного документа, например, www.yandex.ru, не допускается. Ссылки на сайты компаний даются по тексту документа в круглых скобках, например, (www.ibm.com).
2.5 Содержание и оформление графической части Графическая часть курсовой работы должна содержать 2 листа формата А (594х840) или 8 листов формата А3. Листы графической части подшиваются после защиты в РПЗ. Рекомендуется использовать форматы А4 или А3 с целью более аккуратной комплектации итоговой РПЗ.
Не допускается склеивать листы из листов меньших форматов. При выдаче задания на проектирование руководитель проекта по согласованию с консультантами разделов конкретизирует содержание графического материала.
В соответствии с ГОСТ 2.102-68 к документам относятся графические и текстовые документы, которые в отдельности или совокупности определяют состав и устройство изделия и содержат необходимые данные для его разработки или изготовления, контроля, приемки, эксплуатации и ремонта.
Демонстрационные плакаты в наглядной форме отражают основное содержание и результаты работы. На демонстрационных плакатах могут быть представлены: схемы испытательных устройств, измерительных приспособлений и характеристики исследуемых объектов; блок-схемы алгоритмов и программ; математические модели процессов; таблицы исходной информации и результаты вычислений; графики и диаграммы в двух и трехмерном изображении; фотографии и рисунки. При необходимости можно использовать различные цвета изображения для выделения различных кривых, временных диаграмм и т.п.
Плакаты выполняются на листах белой плотной бумаги формата А1. Штамп на каждом плакате выполняется на обратной стороне.
При оформлении структурных схем алгоритмов и программ необходимо руководствоваться требованиями ЕСПД.
Условные графические обозначения (УГО) на схемах изображаются по стандарту и соединяются линиями потока – информации, которые параллельны внешней рамке схемы (рис. 2.2).
При оформлении демонстрационного графического материала допускается использование компьютерной техники. При выполнении демонстрационных плакатов следует придерживаться единого стиля представления информации. Примеры плакатов даны в Приложениях.
Рисунок 2.2 – Примеры условных графических обозначений в программных документах Основное направление потока информации идет сверху вниз и слева направо (при этом стрелки на линиях не указывают):
а) случай, когда применение стрелок обязательно (поток информации направлен снизу вверх);
б) пример изображения «Межстрочного соединителя» при переходе к другому листу схемы (допускается не использовать «Межстрочный соединитель», указывая рядом с обрывом линии потока адресные ссылки типа «Лист 05»);
в) приме изображения «Соединителя», который используется в случае, если нецелесообразно проводить линию потока;
г) пример размещения символа идентификатора (слева над УГО);
д) пример размещения краткой информации об УГО (справа над УГО);
е) пример размещения порядковых номеров в разрыве контура УГО;
ж) графическое обозначение случая, когда УГО связано со многими другими УГО, расположенными на разных листах (на входе помещают один «Межстрочный соединитель», внутри которого на первой строке помещают знак #, а на второй координаты УГО «Комментарий»);
з) аналогично ж) дается УГО «Соединитель» и расшифрованный «Комментарий»
или таблица;
и) обозначение условия числа исходов, если число исходов больше трех (условие исхода проставляется в разрыве линий потока, адрес исхода – в продолжении условия исхода и отделяется от него пробелом, первые три знака адреса – цифры – обозначают номер листа схемы, а два последних знака – буква и цифра – координату символа);
к) обозначение условия исхода, если число исходов не больше трех.
Для оформления пояснительной записки рекомендуется использовать текстовые редакторы (OpenOffice, Microsoft Word и др.) редакторы электронных таблиц (Microsoft Excel и т.д.). Для оформления графического материала - графические редакторы (Microsoft Visio, Adobe Illustrator, Adobe Photoshop и др.). Подготовка графического материала средствами встроенных графических редакторов (Microsoft Word, WordPad и т.д.) не допускается. Иллюстрации должны вставлять в текст в режиме обтекания «в тексте», как статичное не редактируемое изображение. При этом должны выполняться требования ГОСТ 2.004-88.
3 ОБЩИЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ИСХОДНОГО КОДА
ПРОГРАММНЫХ СИСТЕМ
3.1 Общие положения Настоящая часть регламента устанавливает требования к исходным текстам программ и правила использования инструментальных средств среды программирования.Данный раздел включает в себя описание используемых названий и расширений файлов. Рекомендованные расширения файлов представлены в таблице 3.1.
Таблица 3.1 – Рекомендуемые расширения файлов Правила формирования имен файлов определяются применяемыми инструментальными средствами. Например, для файлов с исходным кодом Java имя файла совпадает с названием класса или интерфейса, который описан в данном файле.
Если новый файл не относится к категории, для которой правило формирования наименования определяется применяемым инструментальным средством, то имя файла согласовывается с преподавателем.
Все имена файлов задаются в нижнем регистре.
В таблице 3.2 перечислены наиболее часто используемые имена фалов в JSF приложениях.
Таблица 3.2 – Рекомендуемые имена файлов readme Рекомендуемое имя для файла, включающего описание содержимого index.jsp Имя файла начальной страницы для каталога, в котором она находится.
Файл состоит из разделов, которые должны быть отделены друг от друга пустыми строками и дополнительными комментариями, идентифицирующими каждый раздел.
Файлы длиннее 2000 строк тяжелы для восприятия. Их нужно избегать.
3.2 Общие требования к исходному коду программных систем на Каждый файл исходного кода Java содержит единственный public класс или интерфейс. Если private классы и интерфейсы связаны с public классом, допускается поместить их в одном файле. Описание public класса или интерфейса должно быть первым в файле.
Файлы исходного кода Java имеют следующую структуру:
начальные комментарии (см. "Начальные комментарии");
объявление Пакета (packages) и Импортируемых библиотек (import);
объявление класса (class) или интерфейса (interface).
Все файлы исходного кода должны начинаться с c-style комментариев, которые включают в себя название класса, информацию о версии, дата создания и информацию об авторских правах.
Для возможности ссылки на листинг по тексту РПЗ его необходимо размещать в таблице (табл. 3.3). При использовании электронных редакторов листинг кода ПО рекомендуется оформлять шрифтом Courier New (кегль не более 10).
Таблица 3.3 – Листинг начальной части блока исходного кода * Информация о версии * Информация об авторских правах (разработчике) Первой, не комментированной строкой любого файла исходного кода Java должна быть строка, содержащая имя пакета, начинающаяся со слова package. После нее могут следовать произвольное число строк описывающих импортируемые библиотеки, начинающиеся со слова import. Например:
package java.awt;
import java.awt.peer.CanvasPeer;
Таблица 3.4 описывает объявление класса/интерфейса.
Таблица 3.4 – Объявление класса/интерфейса класса/интерфейса 1 Документируемые комментарии См. “Документируемые комментарии” класса/интерфейса(/**...*/) Чтобы посмотреть информацию, которая 2 Объявление class или interface 3 Комментарии реализации клас- Данные комментарии содержат любую информацию са/интерфейса (/*...*/), если не- о реализации класса/интерфейса, которая не будет 4 Константы (final) Сначала описываются переменные класса public, 5 Переменные класса (static) Сначала описываются переменные класса public, 6 Переменные экземпляра Сначала описываются public переменные, затем 7 Конструкторы http://oracle.iu4.bmstu.ru в разделе проекты.
3.3 Общие требования к исходному коду программных систем на Каждый запрос должен иметь вначале описание всех возвращаемых колонок, или набор документированных индексов, применяемых для доступа к этим полям как элементам массива, полученного в результате вызова GetRows. Для формирования текста запросов рекомендуется использовать шаблон, представленный в табл.3.5:
Таблица 3.5 – Листинг шаблона SQL запросов [right | left|outer|inner] join.[Таблица Y] [as] on order_expression [ ASC | DESC ] ] При проведении изменений в базе данных (или первичном создании) исходные sql-скрипты должны быть сформированы позадачно в виде инсталляционного комплекта (последовательности выполняемых задач).
Имена sql-файлов (скриптов) должны включать следующие атрибуты: nnxxxx.sql, где:
nn – порядковый номер SQL-файла при запуске;
xxxx – имя подсистемы разработчика - 3 - 4 символа.
Например: 02exam.sql.
Необходимо предусмотреть возможность запуска sql-файлов в назначенной последовательности несколько раз.
При выполнении sql-программы должен включаться вывод результатов в файл.
Для этого необходимо добавить:
в начало файла: SPOOL хххххххх.lst, где хххххххх – имя файла sql-программы;
в конец файла: SPOOL off.
Необходимо, чтобы в sql-программе при выполнении действий с объектом базы данных отражалось имя этого объекта, например:
PROMPT создается TABLE Следует включить в команду CREATE INDEX опцию TABLESPACE и предусмотреть возможность интерактивной подстановки имени табличного пространства администратору базы данных в момент выполнения sql-программы:
CREATE INDEX i_table1 ON table1...TABLESPACE &&tablespace;
Перед командой создания синонимов должна ставиться команда удаления синонимов с тем же именем:
DROP PUBLIC SYNONYM xxx...
CREATE PUBLIC SYNONYM xxx...
В случае необходимости выборочной выгрузки таблиц необходимо подготовить файл параметров с названием таблиц в следующем формате:
tables=username.table_name tables=username.table_name где username – владелец таблиц, table_name – название таблицы.
Данные в файл параметров использовать только прописные буквы.
Возможно, использовать 4 типа комментариев реализации: блочные, однострочные, замыкающие, end-of-line комментарии.
View рекомендуется применять только для форматированного вывода и не должны участвовать в Update- и Delete-операторах (и в сложных выборках).
Все хранимые процедуры должны возвращать 0 в случае успеха или отрицательное число с кодом ошибки.
Рекомендуется избегать неоправданной рекурсии в хранимых процедурах и функциях.
Создание общих синонимов должно прописываться в тех же SQL-программах, что и создание объектов.
Требуется писать комментарии в тексте хранимых процедур и комментировать таблицы, представления и их поля с помощью SQL команды COMMENT.
Необходимо использовать существующую систему разграничения доступа или, по крайней мере, предусмотреть в коде представлений и хранимых процедур места, куда в будущем можно было бы вставить процедуры системы разграничения доступа. Эти процедуры отвечают на вопрос «имеет ли текущий пользователь право сделать данное действие над данным объектом», а представления показывают совокупность разрешенных действий над объектами для текущего пользователя (табл. 3.6).
Таблица 3.6 – Листинг обработки исключений try { выражения;
} catch (ExceptionClass e) { выражения;
try { выражения;
} catch (ExceptionClass e) { выражения;
} finally { выражения;
Хранимые процедуры не должны находиться в состоянии ожидания освобождения заблокированных другими пользователями записей длительное время. Для этого перед попыткой захвата данных необходимо убедиться в отсутствии чужих блокировок (SELECT... FOR UPDATE...NOWAIT), и в случае наличия блокировок пользователю должно быть выдано соответствующее сообщение.
При написании хранимых процедур нужно считать, что на Delphi-клиенте выбран режим работы SHARED NOAUTOCOMMIT.
Ошибки хранимых процедур, как логические, так и подключения к ORACLE, должны обрабатываться в самих процедурах с выполнением ROLLBACK, по крайней мере, до точки вызова процедуры. При этом к клиенту не должен возвращаться текст сообщения ORACLE SERVER об ошибке. Вместо этого клиенту должен возвращаться код ошибки и подробное описание ошибки, созданное разработчиком.
В начале процедуры должны быть комментарии, отражающие следующие сведения:
наименование подсистемы;
наименование модуля;
версия и дата последнего обновления;
фамилия разработчика;
краткое назначение;
комментарий к каждому входному и выходному параметру;
производит ли процедура фиксацию транзакций во время своей работы;
до какой точки производится откат транзакций в случае ошибки;
оставляет ли процедура заблокированные записи в таблицах после выполнения Пустые строки улучшают читаемость кода, разбивая его на секции.
Две пустые строки используются в двух случаях:
между секциями файла исходного кода;
между определениями класса и интерфейса.
Одна пустая строка используется в следующих случаях:
между методами;
между локальными переменными и первым выражением в теле метода;
перед блочными или однострочными комментариями;
между логическими блоками внутри метода для улучшения читаемости кода.
«