Система технической документации на АСУ |
ГОСТ 24.207-80 |
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ ПО ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ |
|
System of technical documentation for computer control systems. Requirements for contents of documents on software |
Постановлением Государственного комитета СССР по стандартам от 14 мая 1980 г. № 2101 срок введения установлен
с 01.01 1981 г.
Настоящий стандарт распространяется на техническую документацию на автоматизированные системы управления (АСУ) всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает требования к содержанию документов, входящих в соответствии с ГОСТ 24.101-80 в состав документации программного обеспечения в проектах АСУ.
1.1. Документация программного обеспечения предназначена:
1.2. При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками соответствующей части.
1.3. В зависимости от назначения и специфических особенностей создаваемых АСУ допускается включать в документы дополнительные разделы, требования к содержанию которых не установлены настоящим стандартом. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.
1.4. Требования к содержанию документов «Техническое задание», «Пояснительная записка», «Описание применения», «Спецификация», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний» установлены ГОСТ 19.201-78 , ГОСТ 19.404-79 , ГОСТ 19.502-78 , ГОСТ 19.202-78 , ГОСТ 19.505-79 , ГОСТ 19.401-78 , ГОСТ 19.501-78 и ГОСТ 19.301-79 .
(Измененная редакция, Изм. № 1).
2.1.1. Документ должен содержать вводную часть и разделы:
2.1.2. Вводная часть должна содержать основные сведения о техническом, информационном и других видах обеспечения АСУ, необходимые для разработки программного обеспечения, или ссылку на соответствующие документы проекта АСУ.
2.1.3. Раздел «Структура программного обеспечения» должен содержать перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
2.1.4. Раздел «Основные функции частей программного обеспечения» должен содержать подразделы, в которых для каждой части программного обеспечения приводят назначение и описание основных функций
(Измененная редакция, Изм. № 1).
2.1.5. Раздел «Методы и средства разработки программного обеспечения» должен содержать перечень методов программирования и средств разработки программного обеспечения АСУ с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
2.1.6. Раздел «Операционная система» должен содержать:
2.1.7. Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать:
2.2.2. Для программы (комплекса программ), получаемой за счет использования ранее разработанных программных средств, документ «Описание программы» следует дополнять разделом «Настройка программных средств».
2.2.3. Раздел «Настройка программных средств» должен содержать:
2.3.1. Документ по составу разделов и их содержанию должен соответствовать ГОСТ 19.504-79 и, кроме того, включать раздел «Сведения о форме представления программы (комплекса программ)».
2.3.2. Раздел «Сведения о форме представления программы (комплекса программ)» должен содержать сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, а также сведения, необходимые для чтения информации с носителя.
2.3.3. Для программы (комплекса программ), допускающей настройку на условия конкретного применения, в документ «Руководство программиста» включают разделы:
2.3.4. Разрешается для программы (комплекса программ), допускающей настройку на условия конкретного применения, вместо разделов, перечисленных в п. 2.3.3, разрабатывать отдельный документ «Руководство системного программиста», удовлетворяющий требованиям ГОСТ 19.503-79 .
2.4.1. Документ должен содержать разделы:
2.4.2. Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функции, из числа реализуемых программой (комплексом программ), проверяемых контрольным примером.
2.4.3. Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы (комплекса программ) с приведением исходных данных. Допускается исходные данные представлять в виде распечатки с АЦПУ.
2.4.4. Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой (комплексом программ), позволяющие оценить правильность выполнения проверяемых функции и значение проверяемых параметров. Допускается результаты расчета приводить в виде распечатки с АЦПУ.
2.4.5. Раздел «Проверка программы (комплекса программ)» должен содержать:
Стандарты ЕСПД определяют общие положения и основополагающие стандарты, правила выполнения документации разработки, правила выполнения документации изготовления, правила выполнения документации сопровождения, правила выполнения эксплуатационной документации, правила обращения программной документации и прочие стандарты. В состав ЕСПД входят:
· · основополагающие и организационно-методические стандарты;
· · стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;
· · стандарты, обеспечивающие автоматизацию разработки программных документов.
Вообще перечень документов ЕСПД очень обширен. В него, в частности, входят следующие ГОСТы:
ГОСТ 19.001-77 ЕСПД. Общие положения.
ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов (переиздан в ноябре 1987г с изм.).
ГОСТ 19.102-77 ЕСПД. Стадии разработки.
ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.
ГОСТ 19.104-78 ЕСПД. Основные надписи.
ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.
ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.
ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.
ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.
ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.
ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.
ГОСТ 19.402-78 ЕСПД. Описание программы.
ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.
ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.
ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.
ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.
ГОСТ 19.504-79 ЕСПД. Руководство программиста.
ГОСТ 19.505-79 ЕСПД. Руководство оператора.
ГОСТ 19.506-79 ЕСПД. Описание языка.
ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.
ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
ГОСТ 19.781-90. Обеспечение систем обработки информации программное.
Как видно, основная часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Частично эти стандартны морально устарели, к тому же они не лишены некоторых недостатков. Во-первых, в них не отражены некоторые современные тенденции оформления программ и программной документации, во-вторых, в этих стандартах наличествует многократное дублирование фрагментов программной документации. Тем не менее, за неимением лучшего ориентироваться приходится именно на них.
Итак, стандарты ЕСПД упорядочивают процесс документирования программных систем. Однако, во-первых, предусмотренный стандартами ЕСПД состав программных документов вовсе не такой "жесткий", как может показаться: стандарты позволяют вносить в комплект документации на программной системы (ПС) дополнительные виды, а, во-вторых, исходя из требований заказчика, допустимы некоторые изменения как в структуре, так и в содержании установленных видов ПД. Более того, можно отметить, что стандарты ЕСПД (а это относится и ко всем другим стандартам в области ПС - ГОСТ 34, Международному стандарту ISO/IEC, и др.) носят рекомендательный характер. Дело в том, что в соответствии с Законом РФ "О стандартизации" эти стандарты становятся обязательными на контрактной основе – т.е. при ссылке на них в договоре на разработку (поставку) ПС.
Прежде, чем приступить к рассмотрению правил составления программной документации, необходимо сделать следующее замечание. Каждый документ желательно предварять некоторым введением. Во введении говорятся общие слова. Об актуальности, о необходимости и т.п. Цель Исполнителя здесь – показать значимость и необходимость выполнения этой работы. Начало обычно стандартное: "Существующие в настоящее время многочисленные системы... ... открывает реальные перспективы в..." и т.п.Сюда же обычно вставляются цитаты из выступлений различных деятелей (это – сугубо психологический аспект): "…как говорилось на прошедшем пленуме, съезде, конференции и т.д.). Можно начать и с того, что "…Сегодня, в эпоху коренных социально-экономических преобразований…и т.д." . В общем, главное здесь не переборщить.
И еще. Описывая свой продукт, разработчик зачастую путает понятия компонента и комплекса. Это – разные виды программ. Компонент определяется как "программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса" , а комплекс – это "программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса" .
ГОСТ 19.101-77
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ
Unified system for program documentation. Types of programs and program documents
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в июне 1981 г. (ИУС 9-81).
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
(Измененная редакция, Изм. N 1).
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл.1.
Таблица 1
Вид программы | Определение |
Компонент | Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса |
Комплекс | Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса |
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2, 1.3. (Измененная редакция, Изм. N 1).
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл.2.
Таблица 2
Вид программного документа | |
Спецификация | Состав программы и документации на нее |
Перечень предприятий, на которых хранят подлинники программных документов |
|
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
|
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
2.3. Виды эксплуатационных документов и их содержание приведены в табл.3.
Таблица 3
Вид эксплуатационного документа | |
Перечень эксплуатационных документов на программу |
|
Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения |
|
Руководство программиста | Сведения для эксплуатации программы |
Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
Описание языка | Описание синтаксиса и семантики языка |
Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл.4.
Таблица 4
Код | Вид документа | Стадии разработки |
|||
Эскизный проект | Технический проект | Рабочий проект |
|||
компонент | комплекс |
||||
Спецификация | |||||
Ведомость держателей подлинников | |||||
Текст программы | |||||
Описание программы | |||||
Ведомость эксплуатационных документов | |||||
Формуляр | |||||
Описание применения | |||||
Руководство системного программиста | |||||
Руководство программиста | |||||
Руководство оператора | |||||
Описание языка | |||||
Руководство по техническому обслуживанию | |||||
Программа и методика испытаний | |||||
Пояснительная записка | |||||
Прочие документы |
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.
2.2-2.5. (Измененная редакция, Изм. N 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии "Рабочий проект".
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. N 1).
Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной
документации: Сб. ГОСТов. -
М.: Стандартинформ, 2010
Здесь я хочу сосредоточиться только на одной теме, с которой приходиться иметь дело программисту в отечественных предприятиях, особенно в НИИ - на наборе стандартов ЕСПД. Не считаю себя большим знатоком ЕСПД - есть люди, которые десятки лет по нему работают, и наверняка меня поправят. Статья скорее пытается набросать контуры «дорожной карты» для тех, кто только входит в курс дела.
Системы обозначений на каждом уровне и в каждой организации свои, для каждого случая придется разбираться отдельно. Чтобы быстро понять, “чей” стандарт перед глазами, можно использовать шпаргалку .
Если известно обозначение стандарта, то получить его коды по КГС и ОКС можно, к примеру, на вот этом толковом сайте .
Итак, вернемся к обозначениям ГОСТов. Их может быть два варианта:
В следующих частях планирую уже добраться до конца списка стандартов ЕСПД.
Правила оформления и требования к содержанию курсовых |
Редакция 2 |
||||
проектов (работ) и выпускных квалификационных работ |
стр. 39 из 73 |
||||
Сборочный чертёж сборочной единицы |
|||||
под номером 8, входящей в изделие 1 |
ПК.760108.000 СБ |
||||
Сборочный чертёж отдельной сборочной |
|||||
единицы 4 |
ПК.760004.000 СБ |
||||
Чертёж общего вида отдельной сборочной |
|||||
единицы 4 |
ПК.760004.000 ВО |
||||
Чертёж детали под номером 16, входящей в |
|||||
сборочную единицу 8 изделия 1 |
|||||
Чертёж детали под номером 120, входящей в |
|||||
отдельную сборочную единицу 4 |
|||||
Схема электрическая принципиальная изделия 1 |
ПК.760100.000 Э3 |
||||
Схема кинематическая принципиальная отдель- |
|||||
ной сборочной единицы 4 |
ПК.760400.000 К3 |
||||
Спецификация сборочной единицы 8 изделия 1 |
10 Оформление технологических документов
10.1 Технологические документы курсовых проектов (работ) и выпускных квалификационных работ оформляются в соответствии с требованиями стандартов ЕСТД.
10.2 Технологические документы должны включать:
– титульный лист, оформленный в соответствии с ГОСТ 3.1105-84 «ЕСТД. Форма и правила оформления документов общего назначения» (форма 2а).
– маршрутную карту, оформленную по ГОСТ 3.1118-82 «ЕСТД. Формы и правила оформления маршрутных карт»;
– операционные карты механической обработки и операционные
расчётно-технологические карты на технологические операции, на станках с ЧПУ − по ГОСТ 3.1404-86 «ЕСТД. Формы и правила оформления документов на технологические процессы и операции обработки резанием»;
– операционные карты слесарных, слесарно-сборочных работ по ГОСТ 3.1407-86 «ЕСТД. Формы и требования к заполнению и оформлению документов на технологические процессы (операции), специализированные по методам сборки»;
– карты эскизов (в случае необходимости) по ГОСТ 3.1105-84 и ГОСТ 3.1128-93 «ЕСТД. Общие правила выполнения графических технологических документов»;
– операционные карты технологического контроля по ГОСТ 3.1502-85 «ЕСТД. Формы и правила оформления документов на технический контроль»;
– другие технологические документы (в случае необходимости или по решению руководителя проекта).
10.3 Ремонтные чертежи выполняются в соответствии с правилами, предусмотренными ГОСТ 2.604-88 «Чертежи ремонтные».
10.4 Технологические документы должны быть сброшюрованы
непосредственно в пояснительной записке курсового (проекта) работы или после приложений, спецификаций и перечней элементов. Технологические документы имеют собственную нумерацию.
11 Оформление программных документов
11.1 Разработанные в курсовых проектах (работах) и выпускных квалификационных работах документы различных проблемных областей должны быть оформлены следующим образом:
– программные документы – в соответствии с требованиями ЕСПД,
– документы для автоматизированной системы управления – по государственным стандартам системы технологической документации на АСУ. 11.2 Программные документы (листинги программ) должны включать:
– текст программы, оформленный согласно ГОСТ 19.401;
– описание программы, выполненное согласно ГОСТ 19.402;
– описание примечания, приведённое согласно ГОСТ 19.502;
– другие программные документы (при необходимости).
11.3 Листинги программ размещаются в приложениях с обязательными ссылками на них в ПЗ.
11.4 Программный код может быть сопровождён комментариями. При оформлении листингов рекомендуется использовать шрифт Courier New, размер – 12 пт, межстрочный интервал – одинарный. Рекомендуется отделять смысловые блоки пустыми строками, а также визуально обозначать вложенные конструкции с помощью отступов.
11.5 Ключевые слова и комментарии в листинге программ могут быть выделены с помощью курсива. В основном тексте ПЗ курсивом следует выделять имена библиотек, подпрограммы, константы, переменные и т.д.
11.6 Листинги программ должны иметь порядковую нумерацию в пределах приложения. Номер листинга должен состоять из обозначения приложения и порядкового номера листинга, разделенных точкой, например: «Листинг А.3» – третий листинг приложения А. Если в проекте (работе) содержится только один листинг, он обозначается «Листинг 1». При ссылке на листинг в тексте ПЗ следует писать слово «Листинг» с указанием его номера.
11.7 Название листинга программы оформляется тем же шрифтом, что и основной текст, и размещается над листингом слева, без абзацного отступа, через тире, после номера листинга.
Пример оформления листинга программы Листинг А.3 – Программа « Вывод двумерного массива»
mas:array of integer; {объявление двухмерного массива } i,j:integer;
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
{ Ввод значений элементов массива} for i:=1 to 5 do
for j:=1 to 5 do readln(mas);
{Вывод значений элементов массива} for i:=1 to 5 do begin
for j:=1 to 5 do write(" ",mas); writeln;
12 Нормоконтроль
12.1 Нормоконтроль является завершающим этапом разработки документов курсового проекта (работы) и ВКР.
12.2 Нормоконтроль должен соответствовать требованиям ГОСТ 2.111.
12.3 Нормоконтролю подлежат выпускные квалификационные работы. Нормоконтроль курсовых проектов (работ) проводится преподавателем при защите работы. Проведение нормоконтроля направлено на правильность выполнения текстовых и графических документов курсовых проектов (работ) и ВКР (далее документов) в соответствии с требованиями ГОСТ, стандартов ЕСКД, ЕСПД и ЕСТД.
12.4 Нормоконтроль выполняется нормоконтролёром с учётом требований, действующих на данный момент, стандартов и нормативно-технических документов.
12.5 В процессе нормоконтроля пояснительных записок курсовых проектов (работ) и ВКР проверяется:
– соблюдение правил оформления согласно настоящему Положению;
– внешний вид ПЗ;
– комплектность ПЗ в соответствии с заданием на проектирование;
– правильность заполнения титульного листа, наличие необходимых подписей;
– правильность заполнения ведомости проекта (работы);
– наличие и правильность рамок, основных надписей на всех страницах;
– выделение заголовков, разделов и подразделов, наличие красных строк;
– правильность оформления содержания, соответствие названий разделов и подразделов в содержании соответствующим названиям в тексте записки;
– правильность нумерации страниц, разделов, подразделов, рисунков, таблиц, формул;
– правильность оформления рисунков;
– правильность оформления таблиц;
– правильность размерностей физических величин, их соответствие СИ;
– соответствие нормам современного русского языка;
– правильность примененных сокращений слов;
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
– наличие и правильность ссылок на используемые источники;
– наличие и правильность ссылок на нормативные документы;
– правильность оформления списка использованных источников;
– правильность оформления приложений.
12.6 В процессе нормоконтроля графических документов курсовых проектов (работ) и ВКР проверяется:
– соответствие оформления чертежей требованиям действующих стандартов;
– выполнение чертежей в соответствии с требованиями нормативных документов;
– соблюдение форматов, правильность их оформления;
– правильность начертания и применения линий;
– соблюдение масштабов, правильность их обозначения;
– достаточность изображений (видов, разрезов, сечений), правильность их обозначения и расположения;
– соблюдение условных обозначений элементов в схемах и правил их выполнения в соответствии с требованиями ЕСКД.
12.7. Нормоконтроль выпускных квалификационных работ рекомендуется проводить в два этапа: после черновой (или в тонких линиях) и окончательной разработки оригиналов документов. Разрабатываемые документы должны предъявляться на нормоконтроль комплектно, т.е. текстовая (пояснительная записка) и графическая документация (чертежи, спецификации и т.п.).
12.8 Перечень замечаний нормоконтролёра составляется в том случае, если контроль проводится в отсутствие студента-разработчика и сущность ошибок может быть им неправильно истолкована.
12.9 Проверенные нормоконтролёром в присутствии студента-разработчика документы вместе с перечнем замечаний (если он составляется) возвращаются студенту для внесения исправлений и переработки. Если замечания существуют, пометки нормоконтролёра сохраняются до подписания им документа. Если документ заново перерабатывается студентом, то на повторный контроль сдаются оба экземпляра: с пометками нормоконтролера и переработанный.
12.10 Предъявляемые на подпись нормоконтролёру документы должны иметь все визы согласования, кроме визы заведующего кафедрой. Чистовые оригиналы курсовых и дипломных проектов (работ) нормоконтролёр подписывает
в графе «Н.контр.» основной надписи.
12.11 Запрещается без ведома нормоконтролёра вносить какие-либо изменения в документ после того, как этот документ подписан и завизирован нормоконтролёром.
12.12 Нормоконтролёр имеет право в обоснованных случаях не подписывать предоставленный документ:
– при невыполнении требований нормативных документов;
– при отсутствии обязательных подписей;
– при небрежном выполнении;
– при нарушении установленной комплектности.
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
12.13 Нормоконтролёр несёт ответственность за соблюдение в разрабатываемой документации требований действующих стандартов и других нормативно-технических документов наравне с разработчиками документации.
13 Рецензирование ВКР
13.1 Для получения дополнительной объективной оценки представляемой к защите выпускной квалификационной работы проводится внешнее рецензирование выпускной квалификационной работы специалистами в соответствующей области.
13.2 Рецензентами выпускных квалификационных работ являются высококвалифицированные специалисты, персональный список которых определяется выпускающей кафедрой. В качестве рецензентов могут привлекаться специалисты-практики и преподаватели других вузов.
Направление на рецензию выдается выпускающей кафедрой, форма, которого представлена в приложении Т настоящих Правил.
13.3 Рецензент должен быть ознакомлен со всеми требованиями, предъявляемыми к выпускной квалификационной работе (ВКР).
13.4 Рецензия оформляется в письменном виде и содержит аргументированные оценки:
– актуальности темы ВКР;
– соответствии содержания ВКР заданию на его разработку;
– правильности логической структуры ВКР;
– эффективности и обоснованности проектных решений;
– достоинства и недостатков ВКР, соответствие ее квалификационным требованиям выпускника по направлению подготовки;
– оформления ВКР.
В заключительной части рецензии даются выводы о полноте разработки темы, в соответствие с поставленными задачами, о теоретическом или практическом значении ВКР, о возможной области использования результатов ВКР. Рецензент оценивает работу по четырёхбалльной шкале («отлично», «хорошо», «удовлетворительно», «неудовлетворительно») и указывает возможность присвоения студенту должной квалификации.
13.5 Объем рецензии на выпускную квалификационную работу должен составлять 2-3 страницы печатного или четко написанного от руки текста. Подписанная рецензия должна быть представлена на кафедру, не позднее, чем за три дня до защиты ВКР.
13.6 Рецензия может быть выполнена на фирменном бланке организации (место работы рецензента), либо на бланке установленной формы, регламентированной настоящими Правилами (приложение У) и заверена печатью организации, либо печатью отдела кадров (общего отдела, канцелярии) с отметкой «подпись верна».
13.7 На защиту ВКР в комиссию по государственной аттестации можно дополнительно представить отзыв ведущей организации, по заказу которой
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
выполнялась ВКР. В отзыве должна быть отмечена практическая ценность полученных результатов.
14 Отзыв на ВКР
14.1 Отзыв на выпускную квалификационную работу составляется непосредственно ее руководителем. Отзыв должен характеризовать ВКР с разных сторон: со стороны содержания, структуры, полноты раскрытия выбранной темы и т.д.
14.2 Руководитель должен изложить в отзыве свое объективное мнение о выпускной квалификационной работе студента. В частности, отзыв должен содержать сведения:
– об актуальности темы работы;
– о соответствии выпускной квалификационной работы требованиям, предъявляемым стандартами;
– о владении студентом методами сбора, обработки и анализа информации применяемой в сфере профессиональной деятельности;
– о способности студента самостоятельно работать с источниками ясно, четко последовательно излагать материал;
– о положительных сторонах работы;
– о недостатках и замечаниях по содержанию работы и др.
14.3 Отзыв на выпускную квалификационную работу научного руководителя может содержать предложения относительно общей оценки работы.
14.4 В заключении отзыва, руководитель делает вывод о возможности представления к защите выпускной квалификационной работы к защите в ГАК.
14.5 Текст отзыва руководителя на ВКР печатается на листах формата А4 и подписывается научным руководителем. Форма отзыва на ВКР представлена в приложении Ф.
15 Доклад и презентация
15.1 Доклад (выступление) – это работа презентативного характера, отражающая суть ВКР.
В докладе необходимо затронуть актуальность выбранной темы, теоретические и методические основы работы, а также суммировать и обобщенно изложить полученные в ходе исследования результаты.
В конце выступления необходимо отразить практическую значимость результатов, возможность их внедрения в практику или использования в преподавании.
15.2 Доклад рассчитан на заданное ограниченное время выступления и неразрывно связан с презентацией (раздаточным материалом).
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
15.3 Презентация (раздаточный материал) – это подготовленный с помощью специальных программ (например, Microsoft PowerPoint) наглядный цифровой, табличный и иллюстративный материал, который непосредственно связан с докладом.
15.4 Для презентации выбирается необходимый иллюстрирующий материал, который можно взять как из текста работы, так и из приложений. Это могут быть таблицы, рисунки, схемы, диаграммы, формулы и др. Таблицы не должны быть громоздкими, рисунки не должны быть чрезмерно детальными, формулы должны быть наглядными.
Материал должен иллюстрировать все тезисы, выведенные в докладе.
15.5 Показ презентации может быть осуществлен двумя способами:
– с помощью проектора и на стенде;
– с помощью раздаточного материала в виде бумажных экземпляров для каждого члена комиссии.
Объём презентации может быть от 8 до 12 слайдов.
15.6 Доклад должен содержать только суть рассматриваемого вопроса, минимум цифровых данных, специальных названий, перечислений.
Доклад строится по той же логической схеме, что и проект (работа), то есть: вводная часть, основная часть и выводы. Вводная часть должна содержать в себе актуальность и цель работы, основная часть должна полностью раскрывать рассматриваемую тему. Выводы должны быть краткими и однозначными, следует
в 1-2 предложениях рассмотреть рекомендации для решения поставленных проблем.
15.7 Первым должен быть слайд с темой проекта (работы) и данными исполнителя, то есть: фамилия, имя, отчество, группа, специальность (направление). Желательно указать научного руководителя.
15.8 Курсовой проект (работа) и ВКР сдаются в архив вместе с презентацией, выполненной в электронном виде и записанной на цифровом носитель (например, CD/DVD-диск).
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
Приложение А
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1
Приложение Б
(наименование факультета)
(наименование кафедры)
____________ ________________
ПОЯСНИТЕЛЬНАЯ ЗАПИСКА
к курсовому проекту (работе) по дисциплине (модулю)__
(наименование учебной дисциплины (модуля))
на тему _________________________________________________________________________
_____
_______________________ |
______________________________ |
|
Направление/специальность, профиль/специализация:
___________ _________________________________________________________________
код направления наименование направления (специальности)
________________________________________________________________________________
наименование профиля (специализации)
Обозначение курсового проекта (работы) _________________________ Группа ________
Ростов-на-Дону
Приложение В
МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ
ФЕДЕРАЛЬНОЕ ГОСУДАРСТВЕННОЕ БЮДЖЕТНОЕ ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ ВЫСШЕГО ПРОФЕССИОНАЛЬНОГО ОБРАЗОВАНИЯ
«ДОНСКОЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ» (ДГТУ)
Факультет _______________________________________________________
(наименование факультета)
Кафедра _________________________________________________________
(наименование кафедры)
Зав. кафедрой «______________»
____________ ________________
ПОЯСНИТЕЛЬНАЯ ЗАПИСКА
к дипломному проекту (работе) на тему:
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
__________________________ |
||||
(подпись, дата) |
||||
Обозначение дипломного проекта ______________________ |
Группа ______________ |
|||
Направление (специальность) ___________ |
___________________________________ |
|||
(наименование) |
||||
Руководитель проекта (работы) |
____________________________ |
|||
(подпись, дата) |
(должность, И.О.Ф.) |
|||
Консультанты по разделам: |
||||
_______________________________ |
_____________________ |
|||
(наименование раздела) |
(подпись, дата) |
(должность, И.О.Ф.) |
||
_______________________________ |
_____________________ |
|||
(наименование раздела) |
(подпись, дата) |
(должность, И.О.Ф.) |
||
Нормоконтроль |
_____________________ |
|||
(подпись, дата) |
(должность, И.О.Ф.) |
Ростов-на-Дону
Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1