Белорусский государственный униврситет
МИНИСТЕРСТВО ОБРАЗОВАНИЯ РЕСПУБЛИКИ БЕЛАРУСЬ
БЕЛОРУССКИЙ ГОСУДАРСТВЕННЫЙ УНИВРСИТЕТ
ГУМАНИТАРНЫЙ ФАКУЛЬТЕТ
КАФЕДРА ИНФОРМАЦИОННЫХ ТЕХНОЛОГИЙ
МЕТОДИЧЕСКИЕ УКАЗАНИЯ
ПО ОФОРМЛЕНИЮ И ЗАЩИТЕ КУРСОВЫХ, ДИПЛОМНЫХ РАБОТ И ДРУГИХ ОТЧЕТНЫХ ДОКУМЕНТОВ
СТУДЕНТОВ СПЕЦИАЛЬНОСТИ
«ИНФОРМАТИКА (WEB-ДИЗАЙН И КОМПЬЮТЕРНАЯ ГРАФИКА)»
Минск 2008
В методических рекомендациях изложены требования и правила оформления и защиты студентами курсовых, дипломных и бакалаврских работ, отчетов по преддипломной практике и магистерских диссертаций за период обучения по специальности: «Информатика (WEB-дизайн и компьютерная графика)» на Гуманитарном факультете Белорусского Государственного Университета.
СОДЕРЖАНИЕ
| 1. | Характеристика отчетных документов по курсовому и дипломному проектированию………………………………….. | |
| 2. | Структура и правила оформления отчетного документа…….. | |
| 2.1. | Структура отчетного документа……………………………….. | |
| 2.2. | Правила оформления отчетного документа…………………... | |
| 2.2.1. | Общие требования………………………………………………. | |
| 2.2.2. | Нумерация страниц. Разделов, подразделов, пунктов и подпунктов работы……………………………………………... | |
| 2.2.3. | Перечисления……………………………………………………. | |
| 2.2.4. | Иллюстрации…………………………………………………….. | |
| 2.2.5. | Таблицы………………………………………………………….. | |
| 2.2.6. | Формулы и уравнения…………………………………………... | |
| 2.2.7. | Ссылки…………………………………………………………… | |
| 2.2.8. | Примечания……………………………………………………… | |
| 2.2.9. | Приложения……………………………………………………… | |
| 2.2.10. | Оформление программной документации…………………….. | |
| 2.2.11. | Рекомендуемый объем отчетного документа…………………. | |
| 3. | Подготовка к защите и защита документов…………………… | |
| Литература……………………………………………………….. | ||
| Приложения …………………………………………………….. |
ХАРАКТЕРИСТИКА ОТЧЕТНЫХ ДОКУМЕНТОВ ПО КУРСОВОМУ
И ДИПЛОМНОМУ ПРОЕКТИРОВАНИЮ
Курсовой проект– индивидуальная самостоятельная работа студента по изучению заданного пакета прикладных программ (ППП) и использования его для решения одной или нескольких задач. При выполнении проекта
закрепляются теоретические знания, полученные при изучении предшествующих курсов, что является основой для перехода к выполнению курсовой
работы, дипломной работы, а также других видов работ согласно учебным
планам.
В ходе выполнения курсового проекта делаются первые попытки в про-
явлении творческого и самостоятельного подхода к решению технических и
научно–технических задач, а так же развитию индивидуального творческого мышления студента.
Курсовой проект выполняется параллельно с изучением базовых разделов дисциплин кафедры и завершается в конце осеннего семестра.
Цель курсового проекта:
– закрепление студентом получаемых теоретических знаний;
– привитие студенту навыков самостоятельного изучения программного продукта (как правило, пакета прикладных программ) и умения инсталляции необходимого программного обеспечения на персональный компьютер;
– развитие у студента навыков обобщения основных научных положений по данной теме и возможного практического применения теоретических знаний к решению конкретных задач на базе самостоятельно изучаемого
пакета прикладных программ;
– привитие студенту навыков по информационному поиску и использованию необходимых материалов по исследуемой теме из научно–технической и справочной литературы;
– развитие у студента способностей по анализу сложных теоретических положений и формирование у него модельного подхода к исследованию изучаемых вопросов специальной дисциплины;
– научить студента правилам оформления курсового проекта в соответствии с требованиями, установленными стандартом высшего учебного заведения (ВУЗа) Республики Беларусь;
– указать студенту на необходимость подготовки иллюстративного материала и компьютерной презентации для успешной защиты проекта.
Тема курсового проекта должна отражать материал учебной базовой дисциплины специальных дисциплин, быть составной частью одного из основных научных направлений учебной дисциплины и направленной на разработку новых научных вопросов, либо на уточнение и расширение существующих положений данной отрасли науки с обязательным привлечением возможностей пакетов прикладных программ, которые осваиваются студентом самостоятельно.
В зависимости от содержания учебной дисциплины, по которой выполняется курсовой проект, возможны следующие варианты тематики проекта:
– либо единая тема задания для группы студентов, но с индивидуальными вариантами исходных данных для каждого студента;
– либо набор индивидуальных тем заданий для каждого студента, отражающих в комплексе, по возможности, объем учебного материала по учебной дисциплине.
Исходным этапом к выполнению курсового проекта является задание
на выполнение курсового проекта, в котором приводятся постановка конкретной задачи и пакет прикладных программ, рекомендуемый для ее решения.
Курсовая работа– важный этап обучения студента, где проявляются
навыки ведения самостоятельной научно-исследовательской работы и овладения методикой исследования и эксперимента при решении актуальной задачи в области избранной студентом специальности.
Темы курсовых работ определяются кафедрами.
Студент выбирает одну из предложенных кафедрой тем. При этом тема
курсовой работы четвертого курса может быть продолжением темы курсовой работы предыдущих курсов обучения.
В соответствии с выбранной темой курсовой работы научный руководитель выдает студенту задание, в котором указывается тема, исходные данные для выполнения работы, содержание работы, сроки выполнения курсовой работы, а также согласовывается календарный график выполнения от-
дельных этапов и всей работы.
Отчет по преддипломной (производственной) практикестудентов- научно-технический документ, который содержит систематизированные данные о научно-исследовательской работе, описывающий процесс или результаты научно-технического исследования или состояние научно-технической проблемы, выполненный студентом (студентами) под руководством научного руководителя во время преддипломной (производственной) практики.
Дипломная работа– заключительный этап обучения студента в высшем учебном заведении.
Она имеет своей целью:
– закрепление и углубление теоретических и практических знаний по избранной специальности и применение их для решения конкретных задач;
– формирование навыков ведения самостоятельной проектно-конструкторской или исследовательской работы и овладение методикой
проектирования или научного исследования и эксперимента;
– приобретение навыков обобщения и анализа результатов, полученных другими разработчиками или исследователями;
– выяснение подготовленности студента для самостоятельной работы в условиях современного производства, прогресса науки, техники и культуры.
Дипломная работа является квалификационной работой выпускника. По уровню выполнения дипломной работы и результатам её защиты Государственной экзаменационной комиссией (ГЭК) делается заключение о возможности присвоения выпускнику соответствующей квалификации.
Тематика дипломных работ и их руководители определяются выпускающими кафедрами, утверждаются Советом факультета и приказом ректора университета. При определении тематики следует учитывать конкретные задачи в данной области. Тематика дипломных работ должна быть актуальной, соответствовать современному состоянию и перспективам развития науки, техники и культуры, по своему содержанию отвечать задачам, изложенным выше.
Студентам предоставляется право выбора темы дипломной работы.
Студент может предложить свою тему дипломной работы. В этом случае он
должен обратиться к заведующему кафедрой с письменным заявлением, в котором обосновывается целесообразность работы по выбранной теме. При
положительном решении вопроса тема дипломной работы включается в перечень тем кафедры.
Желательно, чтобы тема работы являлась продолжением выполненных студентом курсовых работ на третьем и четвертом курсах, что характеризует
существенный объем исследований в области избранной им специальности.
В соответствии с темой дипломной работы руководитель этой работы
выдает студенту задание на дипломное проектирование. Задание, подготовленное руководителем, утверждается заведующим кафедрой. Это задание
вместе с дипломной работой так же представляется в ГЭК.
Дипломная работа выполняется студентом в течение промежутка времени, отведенного для этого учебным планом по соответствующей специальности. Рекомендуется включать в этот промежуток времени также время
нахождения студента на преддипломной практике.
Руководитель дипломной работы обязан:
– составить и выдать задание на дипломную работу;
– оказать студенту помощь в разработке календарного плана-графика на весь период выполнения дипломной работы;
– рекомендовать студенту необходимую основную литературу, справочные, архивные материалы и другие источники по теме работы;
– проводить систематические, предусмотренные планом-графиком беседы со студентом, давать студенту консультации, контролировать расчетные и экспериментальные результаты;
– контролировать ход выполнения работы вплоть до ее защиты;
– решить вопрос о допуске студента к защите дипломной работы и подготовить отзыв о выполненной работе.
По предложению руководителя дипломной работы, в случае необходимости, кафедре предоставляется право приглашать консультантов по отдельным узконаправленным разделам дипломной работы за счет лимита времени, отведенного на руководство дипломной работой, или на других условиях, определяемых кафедрой.
Дипломная работа выполняется на основе изучения литературы по специальности: (учебников, учебных пособий, монографий, периодической литературы, журналов на иностранных языках, нормативной литературы и т.п.).
В работе в соответствии с заданием должны быть детально освещены
вопросы темы, включая критический анализ литературных данных и проведенных самостоятельно теоретических и (или) экспериментальных исследований изучаемого вопроса или разрабатываемого объекта. В дипломных работах также должны быть отражены вопросы технологии, стандартизации, экономики, охраны труда и т.п., свойственные особенностям специальности.
Дипломная работа выполняется студентом, как правило, непосредственно в вузе. По отдельным специальностям дипломная работа может выполняться на предприятии, в организации, в научных и проектно - конструкторских и других учреждениях, если тема дипломной работы соответствует
профилю кафедры. При этом студент представляет заведующему кафедрой
задание по теме работы с аннотацией, подписанной предполагаемым внешним научным руководителем. Во всех случаях темы дипломных работ, их
научные руководители и рецензенты утверждаются на заседании кафедры.
Перед началом выполнения дипломной работы студент должен разработать календарный график работы на весь период с указанием очередности
выполнения отдельных этапов, и после одобрения руководителем, представить на утверждение заведующему выпускающей кафедрой.
С целью фиксации степени готовности дипломной работы выпускающая кафедра может устанавливать сроки периодического отчета студентов по
выполнению данной работы. Студент обязан отчитаться перед руководителем или заведующим кафедрой.
Так как темы дипломных работ утверждаются приказом ректора, то изменение наименование темы возможно только в исключительных случаях.
Чтобы изменить наименование темы студенту сначала необходимо подать заявление с визой руководителя на имя декана факультета.
- СТРУКТУРА И ПРАВИЛА ОФОРМЛЕНИЯ ОТЧЕТНОГО ДОКУМЕНТА
ПРАВИЛА ОФОРМЛЕНИЯ ОТЧЕТНОГО ДОКУМЕНТА
ОБЩИЕ ТРЕБОВАНИЯ
Изложение текста и оформление отчетного документа проекта выполняют в соответствии с правилами оформления, которые изложены ниже, а
также требованиями стандартов предприятия БГУ, ГОСТ 7.32, ГОСТ 2.105
и СТБ 6.38-2004. Страницы текста документа и включенные в него иллюстрации и таблицы должны соответствовать формату А4 по ГОСТ 9327. Отчетный документ должен быть подготовлен в электронном виде с использованием компьютера и напечатан на принтере (через один интервал) на одной стороне листа белой бумаги формата А4.
Цвет шрифта должен быть черным, высота букв, цифр и других знаков – не менее 1,8 мм (кегль не менее 12 и не более 14, шрифт – Times New Roman), размеры полей:, верхнее – 20 мм, нижнее –20 мм, правое – 10 мм, левое – 30 мм.
Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты разной гарнитуры.
При выполнении работы необходимо соблюдать равномерную плотность, контрастность и четкость изображения по всей работе, должны быть
четкие, не расплывшиеся линии, буквы, цифры и знаки.
Опечатки, описки и графические неточности, обнаруженные в процессе
подготовки работы, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графики) машинописным способом или черными чернилами, пастой или тушью - рукописным способом.
Повреждение листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (графики) не допускаются.
Фамилии, названия учреждений, организаций, фирм, название изделий
и другие имена, собственные в отчете приводят на языке оригинала. Допускается транслитерировать имена собственные и приводить названия организаций в переводе на язык отчета с добавлением (при первом упоминании) оригинального названия.
В тексте работы не допускается:
– применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
– сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и расшифровках буквенных обозначений, входящих в формулы;
– применять сокращения слов, кроме установленных правилами русской орфографии, а также соответствующими стандартами;
– использовать в тексте математический знак минус (–) перед отрицательными значениями величин. Вместо математического знака (–) следует писать слово “минус”, за исключением использования этого знака в таблицах и формулах;
– употреблять математические знаки без цифр, например : ≤ (меньше
или равно), ≥(больше или равно), ≠ (не равно), а также знаки № (номер),
% (процент);
– применять индексы стандартов (ГОСТ, СТБ, РД, ТУ и т.д.) без регистрационного номера.
Если в работе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например, планки, таблички к элементам
управления и т.п.), то их выделяют шрифтом (без кавычек), например:ВКЛ., ОТКЛ., или кавычками – если надпись состоит из цифр, знаков.
Наименование команд, режимов, сигналов и т.п. следует выделять кавычками, например: “Сигнал +5в включено”.
В тексте работы числа с размерностью следует писать цифрами, а без
размерности словами, например: “Абсолютная погрешность измерения – не
более 2 мм”, “Тест процессора с разными параметрами необходимо запустить два раза”.
В работе следует применять стандартизированные единицы физичских
величин, согласно ГОСТ 8.417.
Если в тексте приведен ряд числовых значений величин, выраженных в
одной и той же единице физической величины, то ее обозначения указывают только за последней значащей цифрой, например: 1,0; 1,5; 2,0; 2,5 мм.
Если приводят диапазоны числовых значений, выраженных в одной и той же единице физической величины, то обозначение единицы указывают за последним значением диапазона, например: от 1 до 5 мм или 1–5 мм.
При указании значений величин с предельными отклонениями числовые значения следует заключать в скобки и обозначения единицы помещать
после скобок или проставлять обозначения единиц после числового значения величины и после ее предельного отклонения, например: (180 ± 2) °С или 180 °С ± 2 °С.
Между последней цифрой числа и обозначением единицы следует оставлять неразделяемый пробел (например, в MS Word это комбинация – Shift + Ctrl + пробел), равный минимальному расстоянию между словами,
например: 100 кВт, 80 %, 2 °С. Исключения составляют обозначения в виде
знака над строкой, перед которыми пробел не оставляют, например: 203.
Обозначения единиц следует применять после числовых значений величин и помещать в одну строку с ним (без переноса на следующую строку).
Точка в конце обозначения единицы физической величины не ставится.
По тексту работы применяются только русские обозначения единиц физических величин согласно Закона о языках РБ.
Текст работы должен быть переплетен.
Наименование структурных частей работы “Реферат”, “Содержание”,
“Обозначения и сокращения”, “Введение”, “Заключение”, “Список использованных источников”, “Приложение” служат заголовками структурных элементов работы, каждый из которых должен начинаться с новой страницы и печатается прописными буквами без точки в конце.
Основную часть работы следует делить на разделы, подразделы и пункты. Пункты при необходимости, могут делиться на подпункты. При делении текста работы на пункты и подпункты необходимо, чтобы каждый пункт содержал законченную информацию.
Разделы, подразделы должны иметь заголовки. Пункты, как правило,
заголовков не имеют. Заголовки должны четко и кратко отражать содержание разделов и подразделов. Заголовки разделов, подразделов и пунктов следует печатать с абзацного отступа с прописной буквы без точки в конце, не подчеркивая. Если заголовок состоит из двух предложений, их разделяют точкой. Переносы слов в заголовках не допускаются.
Расстояние между заголовками структурных элементов и разделов основной части отчета должно быть не менее 2–2,5 интервалов.
Номер раздела
Номер раздела
Номер подраздела
Перечисления
Внутри пунктов или подпунктов могут быть приведены перечисления.
Перед каждым перечислением следует ставить дефис или, при необходимости, ссылки в тексте работы на одно из перечислений, строчную букву (за исключением е, з, о, г, ь, и, ы, ъ), после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа, как показано в примере.
Например:
а) ________
б) ________
1) ___
2) ___
в) _________
Если работа состоит из двух и более частей, каждая часть должна иметь свой порядковый номер. Номер каждой части следует проставлять арабскими цифрами на титульном листе под указанием вида работы, например, “Часть 2”.
Нумерация страниц работы и приложений, входящих в состав работы,
должна быть сквозная.
Иллюстрации
Иллюстрации (чертежи, графики, схемы, компьютерные распечатки, диаграммы, фотоснимки) следует располагать в работе непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. Иллюстрации могут быть в компьютерном исполнении, в том числе и цветные. Чертежи, графики, диаграммы, схемы, иллюстрации, помещаемые
в работе, должны соответствовать требованиям государственных стандартов
Единой системы конструкторской документации (ЕСКД). Допускается выполнение чертежей, графиков, диаграмм, схем посредством использования
компьютерной печати.
Фотоснимки размером меньше формата А4 должны быть наклеены на
стандартные листы белой бумаги или отсканированы и вставлены в отчет.
Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Если рисунок один, то он обозначается “Рисунок 1”. Слово “рисунок” и
его наименование располагают посередине строки.
Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера
иллюстрации, разделенной точкой. Например, Рисунок 1.1.
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово “Рисунок” и наименование
помещают после пояснительных данных и располагают следующим образом: Например, Рисунок 1 – Принципиальная схема полного дешифратора.
Иллюстрации каждого приложения обозначают отдельной нумерацией
арабскими цифрами с добавлением перед цифрой обозначения приложения.
Например, Рисунок Д.3 – ВАХ диода КД213А.
При ссылках на иллюстрации следует писать “ … в соответствии с рисунком 5” при сквозной нумерации и “ … в соответствии с рисунком 7.9” при нумерации в пределах раздела.
При выполнении диаграмм значения величин, связанных изображаемой
функциональной зависимостью, следует откладывать на осях координат в виде шкал.
Диаграммы для информационного изображения функциональных зависимостей допускается выполнять без шкал значений величин. В диаграмме
без шкал оси координат следует заканчивать стрелками, указывающими направления возрастания величин. Допускается применять такие стрелки так же и в диаграммах со шкалами – за пределами шкал или самостоятельные стрелки после обозначения величины – параллельно оси координат. В качестве шкалы следует использовать координатную ось или линию координатной сетки, которая ограничивает поле диаграммы.
В диаграммах, изображающих несколько функций различных переменных, а также в диаграммах, в которых одна и та же переменная должна быть выражена одновременно в различных единицах, допускается использовать в качестве шкал, как координатные оси, так и линии координатной сетки, ограничивающие поле диаграммы или (и) прямые, расположенные параллельно координатным осям.
Координатные оси должны быть разделены на графические интервалы
одним из следующих способов: координатной сеткой; делительными штрихами; сочетанием делительной сетки и делительных штрихов.
Линии в диаграммах следует выполнять по ГОСТ 2.303.
Оси координат, оси шкал, ограничивающие поле диаграммы, следует
выполнять сплошной основной линией. Линии координатной сетки и дели-
тельные штрихи следует выполнять сплошной тонкой линией. Линии функциональной зависимости следует выполнять сплошной линией в два раза толще линий осей координат и (или) координатной сетки.
Переменные величины следует указывать одним из следующих способов: символом; наименованием; наименованием и символом; математическим выражением функциональной зависимости.
В диаграмме со шкалами обозначения величин следует размещать у се-
редины шкалы, с ее внешней стороны, а при объединении символа с обозначением единицы измерения в виде дроби – в конце шкалы, после последнего
числа. В диаграмме без шкал обозначения величин следует размещать вблизи стрелки, которой заканчивается ось. Обозначение в виде символов и математических выражений следует располагать горизонтально, обозначения в виде наименований и символов – параллельно соответствующим осям.
В случае, когда в общей диаграмме изображаются две и более фунцио-
нальной зависимости, у линий, изображающих зависимости, допускается проставлять наименования и (или) символы соответствующих величин, или
порядковые номера. Символы и номера должны быть разъяснены в поясни-
тельной части.
Единицы измерения следует наносить одним из следующих способов:
– в конце шкалы между последним и предпоследним числами шкалы (при недостатке места допускается не наносить предпоследнее число);
– вместе с наименованием переменой величины после запятой;
– в конце шкалы, после последнего числа вместе с обозначением переменной величины в виде дроби, в числителе которой наносят обозначение переменной величины, а в знаменателе – обозначение единицы измерения.
Единицы измерения углов (градусы, минуты, секунды) следует наносить один раз – у последнего числа шкалы.
Пример иллюстрации приведен в приложении Е.
Таблицы
Цифровой материал, как правило, оформляют в виде таблиц. Название
таблицы, при его наличии, должно отражать ее содержание, быть точным и
кратким. Название таблицы следует помещать над таблицей слева, без абзацного отступа в одну строку с ее номером через тире.
При переносе части таблицы название помещают только над первой частью таблицы, нижнюю горизонтальную черту, ограничивающую таблицу,
не приводят. Таблицу следует располагать в работе непосредственно после
текста, в котором она упоминается впервые, или на следующей странице. На
все таблицы должны быть ссылки в работе. При ссылке следует писать слово “таблица” с указанием ее номера. Таблицу с большим количеством строк
допускается переносить на другой лист (страницу). При переносе части таблицы на другой лист слово “Таблица” и ее номер указывают один раз слева
над первой частью таблицы, над другими частями пишут слово “Продолжение” и указывают номер таблицы, например: “Продолжение таблицы 1”.
При переносе таблицы на другою страницу заголовок помещают только над ее первой частью. Головка таблицы при переносе на другой лист (страницу) повторяется.
Таблицу с большим количеством граф допускается делить на части и
помещать одну часть под другой в пределах одной страницы. Если строки и
графы таблицы выходят за формат страницы, то в первом случае в каждой
части таблицы повторяется головка, во втором случае – боковик.
Если повторяющийся в разных строках графы таблицы текст состоит из
одного слова, то его после первого написания допускается заменять кавычками; если из двух и более слов, то при первом повторении его заменяют словами “То же”, а далее – кавычками. Ставить кавычки вместо повторяющихся цифр, марок, знаков, математических и химических символов не допускается. Если цифровые или иные данные в какой-либо строке таблицы не приводят, то в ней ставят прочерк. Слова “более”, “не более”, “менее”, “не менее”, “в пределах” и др. ограничительные слова не допускается указывать в таблицах рядом с числовыми значениями величин. Они должны быть помещены в боковиках таблицы рядом с наименованием соответствующего параметра или указателя после единицы физической величины.
Таблицы, за исключением таблиц приложений, следует нумеровать цифрами сквозной нумерацией. Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, соединенных точкой. Если в работе одна таблица, то она должна быть обозначена “Таблица 1” или “Таблица С.1”, если она приведена в приложении С.
Заголовки граф и строк таблицы следует писать с прописной буквы в
единственном числе, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Таблицы слева, справа и снизу, как правило, ограничивают линиями. Допускается применять размер шрифта в таблице меньший, чем в тексте.
Разделять заголовки и подзаголовки боковика и граф диагональными
линиями не допускается. Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не
затрудняет пользование таблицей. Заголовки граф, как правило, записывают
параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф. Головка таблицы должна быть отделена линией от остальной части таблицы. Единицы физических величин цифровых данных указывают в заголовке каждой графы, после них ставят
запятую. Если все параметры, помещенные в таблице, выражены в одной и
той же величине (например, миллиметрах), сокращенное обозначение единицы физической величины помещают над таблицей.
Примеры оформления таблиц приведены в приложении Д.
Формулы и уравнения
Уравнения и формулы следует выделять из текста в отдельные строки.
Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки. Если уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков (+), (–), умножения (х), (деления) (:), или других математических знаков, причем знак в начале строки повторяют. При переносе формулы на знаке, символизирующем операцию умножение, применяют знак “Х”. Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой в той же последовательности, в которой они даны в формуле. Формулы в работе следует нумеровать порядковой нумерацией в пределах сей работы арабскими цифрами в круглых скобках в крайнем правом положении на строке.
Например:
А = a : b, (1)
Rt = R20 + l + b, (2)
Где: Rt– сопротивление при температуре t 0C; R20– сопротивление при
температуре 20 0C; l, b– коэффициенты.
Одну формулу обозначают – (1). Формулы, помещенные в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например, формула (Д.1).
Рекомендуется нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (4.1). Формулы нумеруются все, независимо
от того, есть на них ссылка или нет. Порядок изложения в работе математических уравнений такой же, как и формул. В работе допускается выполнение
формул и уравнений рукописным способом черными чернилами.
Ссылки
При написании отчетного документа автор обязан давать ссылки на источники, материалы или отдельные результаты, которые приводятся в работе, или на идеях и выводах которых разрабатываются проблемы, задачи, вопросы, и изучению которых посвящена работа. Такие ссылки дают возможность разыскать документы и проверить достоверность сведений о цитировании документа, дают необходимую информацию о нем. Ссылаться следует на последние издания публикаций. На более ранние издания можно ссылаться лишь в тех случаях, когда в них есть нужный материал, не включенный в последние издания.
Источники следует располагать в порядке появления ссылок в тексте
работы. Ссылки на источники следует указывать порядковым номером, выделенным двумя квадратными скобками, например: [5]. При ссылках на иллюстрации следует писать “ … в соответствии с рисунком 3 …” при сквозной нумерации и “ … в соответствии с рисунком 2.5 …” при нумерации в пределах раздела. На все таблицы в работе должны быть ссылки. При ссылке следует писать слово “таблица” с указанием ее номера. Ссылки в работе на порядковые номера формул дают в скобках, например: “ … в формуле (4)”. В тексте работы на все приложения должны быть даны ссылки.
В работе допускаются ссылки на данный документ, стандарты, техние-
ские условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом.
Ссылаться надо на документ в целом или на его разделы и приложения.
Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа.
При ссылках на стандарты и технические условия указывают только их
обозначение, при этом допускается не указывать год его утверждения при условии полного описания стандарта в списке использованных источников в соответствии с ГОСТ 7.1.
Примечания
Слово “Примечание” следует печатать с прописной буквы с абзаца и не
подчеркивать. Примечание приводят в документах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала. Примечания не должны содержать требований. Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания.
Если примечание одно, то после слова “Примечание” ставится тире, а примечание не нумеруют. Если примечаний на одном листе (странице) несколько, то после слова “Примечания” ставят двоеточие и примечания нумеруют по порядку арабскими цифрами без проставления точки. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание
таблицы.
Например:
Примечание – ________________
_____________________________
Например:
Примечания:
1 ____________________________
2 ____________________________
3 ____________________________
Приложения
Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова “ПРИЛОЖЕНИЕ”, напечатанное прописными буквами, и его обозначения. Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы
отдельной строкой.
Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. После слова “ПРИЛОЖЕНИЕ” следует буква, обозначающая его последовательность. Допускается обозначение приложения буквами латинского алфавита, за исключением букв I и О. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами. Если в документе одно приложение, оно обозначается “ПРИЛОЖЕНИЕ А”.
Текст приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого
приложения. Перед номером ставится обозначение этого приложения.
Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц. При необходимости достаточно объемное приложение может иметь свое “Содержание”.
Приложениям или частям, выпущенным в виде самостоятельного документа, обозначение присваивают как части документа с указанием в коде
документа ее порядкового номера.
Оформление программной документации
Программная документация обычно включается в курсовой проект, курсовую (бакалаврскую, дипломную) работу, в отчет по преддипломной практике студентов или в магистерскую диссертацию в виде приложений. Документация должна быть оформлена в соответствии с требованиями действующих стандартов и может включать различные программные документы.
При включении программной документации в отчетный документ рекомендуется подготовить один программный документ “Руководство пользователя”. Другие программные документы: “Тек