Учебное пособие: Методические указания по оформлению курсовых проектов (работ), вкр бакалавров по направлению 552800, дипломных проектов (работ) специалистов по направлению 2201 Курск 2001

Министерство образования Российской Федерации

Курский государственный технический университет

Кафедра вычислительной техники

Компьютерное оформление отчетных документов

Методические указания

по оформлению курсовых проектов (работ), ВКР бакалавров по направлению 552800, дипломных проектов (работ) специалистов по направлению 2201

Курск 2001

Содержание

ВВЕДЕНИЕ

Настоящие методические указания обобщают рекомендации кафедры по выполнению студентами направления 552800 основных отчетных учебных документов и документов других видов (рефераты, отчеты по УИРС, НИРС, отчеты по практике и др.), с применением компьютерных технологий и с соблюдением требований действующих государственных стандартов. При составлении данных методических указаний в качестве доминирующей системы стандартов принята ЕСПД (в отличии от ЕСКД в части «рамок» на листах пояснительной записки, точек после номеров заголовков, нумерации формул, рисунков и таблиц и др.).

1. ТЕКСТОВАЯ ЧАСТЬ УЧЕБНОГО ДОКУМЕНТА

1.1. Состав и план построения

Пояснительная записка к проекту (дипломному и курсовому), текстовая часть работы (дипломной, ВКР и курсовой) содержат:

- титульный лист по образцу, устанавливаемому администрацией университета и представленный на доске объявлений кафедры;

- задание на стандартном бланке;

- реферат объемом до одной страницы с заголовком выровненным по центру. В строке текста приводятся сведения о виде документа и объеме пояснительной записки, например: «Дипломный проект. Пояснительная записка: 53 с., девять табл., 15 рис., 34 источника и четыре прил.» Далее приводится перечисление документов графической части с указанием числа листов. Затем пропускается одна строка и дается перечень ключевых слов и словосочетаний (от пяти до 15 слов) в именительном падеже, напечатанных прописными буквами подряд, через запятые. Они предназначены для информационного поиска, и должны определять по возможности узкую отрасль науки или техники. Слова «Ключевые слова» писать не нужно. Затем вновь пропускается одна строка и дается краткое описание существа работы, которое начинается, например, словами «В проекте предлагается …». Указывается цель и объект проектирования или исследования, использованная методика и полученные результаты. К документу на дискете дается расширенный реферат (см. разд. 3);

- копия реферата на одном из изучаемых в университете иностранных языков;

- «содержание» . Заголовки разделов и подразделов в «содержании» печатаются такими же буквами как на основных своих местах. Номера страниц в «содержании» выравниваются по правому краю. Рекомендуется использовать автоматическое формирование «содержания». Путь: «Вставка»\ «Оглавление и указатели»\ «Оглавление»\ «Из шаблона»\ «ОК». Шаблон нужно настроить, «заполнитель» - лучше выключить;

- введение освещает происхождение темы и ее цель. Здесь обосновывается выбор методики и дается обзор литературы, если он не выделен в особый раздел. В курсовых проектах и работах введение не требуется;

- несколько основных разделов с содержательными заголовками. При необходимости разделы разбиваются на подразделы. Ввиду небольших размеров документов деление подразделов на пункты и подпункты нежелательно;

- заключение может быть разбито на пункты или оформлено как перечисление (в курсовых проектах и работах не требуется);

- перечень сокращений в алфавитном порядке (при использовании в тексте малоупотребительных аббревиатур);

- перечень терминов (при необходимости);

- список использованных источников в порядке ссылок в тексте. В список можно включать только опубликованные материалы (в т.ч. авторские свидетельства, стандарты, методические указания, тезисы докладов). Нельзя включать источники, на которые в тексте не было ссылок. Описания источников делаются по ГОСТ 7.1-84, используется язык цитируемого издания;

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

- приложения необязательные (при необходимости).

1.2. Форматирование текста

При печати текстовых документов на бумаге или при сохранении их в виде магнитной копии должны соблюдаться требования действующих государственных стандартов. В случае противоречия между требованиями различных систем стандартов преимущество отдается ЕСПД. Изложенные ниже рекомендации подразумевают, прежде всего, использование Word6\7\97 \2000 в среде Windows 95\NT\98\2000 , но они приемлемы и при других технологиях. Современные текстовые редакторы имеют богатые возможности изменения стиля текста, но этими возможностями не следует злоупотреблять. Необходимые ограничения состоят в следующем:

- один и тот же шрифт , возможно в разных начертаниях (обычный, полужирный, курсив), должен сохраняться от начала до конца текстового документа. Латинские буквы должны принадлежать тому же шрифту. Размер шрифта должен быть одинаковым, за исключением заголовков высшего уровня, где можно использовать больший размер, и буквенных обозначений на рисунках, где могут использоваться заглавные буквы меньшего размера. Кстати, при редактировании импортированного рисунка масштаб меняется, и бывает трудно обеспечить точное совпадение размеров букв в тексте и на рисунке. При выборе размеров шрифта необходимо ориентироваться не столько на номинал в пунктах, сколько на пробную печать текста. Дело в том, что размер в пунктах (1 п. равен 1/72 дюйма или 0,3528 мм) определяет лишь величину минимально необходимого межстрочного интервала. При одном и том же размере в пунктах разные шрифты имеют неодинаковую плотность и высоту. Рекомендуемый шрифт – Times New Roman 14 п. Необходимо также помнить, что печатный шрифт True Type может сильно отличаться от видимого на экране монитора, что зависит от принтера и драйвера печати. Имея в виду тенденции дальнейшего развития текстовых редакторов, мы рекомендуем применять шестнадцатиразрядные шрифты Unicode ;

- подчеркивания не допускаются;

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

- межстрочный интервал должен быть «полуторным», если документ будет копироваться с уменьшением масштаба (как текст данных «методических указаний»), или «обычным», что больше подходит к учебному документу и не противоречит требованиям стандартов (ГОСТ 19.106-78 и ГОСТ 2.105-95);

- абзац настраивается с выравниванием по ширине и отступом у первой строки 12,5-12,7 мм (стиль «основной текст»). Висячая строка запрещена, автоматический перенос должен быть исключен;

- заголовки и подзаголовки отделяются от предыдущего и последующего текста увеличенными межстрочными интервалами. Для заголовков принять настройку «перед» - 18 п., «после» - 6 п., а для подзаголовка «перед» - 6п., «после» - 6 п. Заголовки выравниваются по центру, а подзаголовки – по левому краю с абзацным отступом. Основные разделы нумеруются арабскими цифрами. Номер с точкой помещаются перед заголовком и отделяется одним пробелом. Подразделы имеют двойную нумерацию: «номер раздела»\точка\«номер подраздела»\точка.

Начинать каждый раздел с новой страницы не обязательно, но не следует его начинать с нижней части страницы. Нельзя отрывать заголовок или подзаголовок от последующего текста. Если заголовок или подзаголовок состоят из двух предложений, последние разделяются точкой. Переносы слов в заголовках и подзаголовках запрещены. В конце заголовка или подзаголовка точка не ставится. Не рекомендуется помещать текст между заголовком и подзаголовком;

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

- стили основного текста, подзаголовка и заголовка полезно настроить заранее и присвоить каждому стилю удобную комбинацию клавиш;

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

- сокращения и специальные термины , кроме общепринятых и установленных стандартами, крайне нежелательны, но если без них нельзя обойтись, то они должны расшифровываться в скобках при первом упоминании в тексте. Если же сокращений и терминов много (более двух –трех в одном разделе), то на них должны составляться специальные списки;

- ссылки на цитируемые источники нумеруются арабскими цифрами в квадратных скобках в порядке упоминания в тексте. Список использованных источников делается по ГОСТ 7.1.-84;

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

- обозначения физических величин не должны отрываться от числовых значений при переносе на следующую строку. Числовые значения с условными обозначениями физических величин пишутся цифрами. Без таких обозначений числовые значения от единицы до девяти пишутся словами, а свыше девяти – цифрами. Если записывается ряд числовых значений одной и той же величины, то ее указывают только в конце, например 1,50; 1,75; 2,00 м;

- формат страницы - А4 (210´297 мм), поля: сверху – 25 мм, снизу – 20 мм, слева – 30 мм, справа – 10 мм. Рамка, ограничивающая текстовое поле, не нужна. В центре верхнего поля помещается номер страницы в виде арабской цифры без всяких дополнительных черточек, а под ним – колонтитул, содержащий децимальный шифр работы (см. стр.14);

- нумерация страниц должна быть сквозной по всему документу, включая бланк задания и приложения. На титульном листе и на бланке задания номер страницы не ставится;

- формулы набираются с помощью редакторов типа Microsoft Equation или MathType . Не нужно отделять формулы от текста дополнительными пропусками строк, т.к. редакторы автоматически выдерживают требуемые интервалы. Разрывать длинные формулы для переноса на новую строку можно только на знаке математической операции, причем в начале новой строки этот знак повторятся. Предшествующий формуле текст, сама формула с расшифровками обозначений и последующий текст должны образовывать правильную грамматическую конструкцию с соответствующей пунктуацией. Номер формулы пишется в круглых скобках с выравниванием по правому краю;

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

Таблица 1 - Название

Боковик Графы

Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе. Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф. Головка таблицы должна быть отделена линией от остальной части таблицы. Большую таблицу можно разместить на отдельной странице, несколько сместив ее ниже по тексту. Если строки или графы таблицы выходят за формат страницы, таблицу делят на части, помещая одну часть под другой или рядом, или же на последующих страницах. При этом в каждой части таблицы повторяют ее головку или боковик. Допускается головку или боковик последующих частей заменять нумерацией граф или строк. При этом графы или строки первой части таблицы должны быть пронумерованы. Заголовки последующих частей таблицы начинаются словами «Продолжение таблицы…». Таблица должна иметь внешнюю рамку, которую Word замыкает вокруг каждой части таблицы при переходе на следующую страницу. Поэтому можно пренебречь требованиями стандарта об оставлении «открытого» нижнего или правого края таблицы в случае ее деления на части. Запрещается делить клетки головки и боковика диагональными линиями. Запрещается также включать в таблицу графу «номер по порядку». Примеры оформления таблиц см. на стр.14,15.;

- рисунки (схемы, диаграммы, тоновая графика, в частности копии окон программных оболочек, шаблоны документов, изображения числовых массивов, карты Карно и пр.) либо вставляются между абзацами текста, сразу после первого упоминания, либо, если это затруднено, оформляются на отдельных страницах. Должны соблюдаться правила оформления схем электрических или схем алгоритмов, графиков и пр. в соответствии с действующими стандартами на эти документы, на условные обозначения и на обозначения физических величин. Схемы электрические, а также схемы алгоритмов и программ могут продолжаться на последующих страницах (где они называются «Продолжение рисунка…»), хотя все сложные графические материалы лучше оформлять не как рисунки в тексте, а как документы графической части работы.

Каждый рисунок должен иметь подрисуночную надпись, состоящую из слова «Рис.», номера рисунка и названия рисунка. После этого (правее или ниже) может располагаться пояснительный текст. Точка в конце подрисуночной надписи не ставится. Можно объединять в одном рисунке несколько изображений, например:

«Рис. 7. Сдвиг содержимого сумматора (а) и сдвиг содержимого регистра деления (б) при реализации деления».

Для электронных компонентов вместо номеров нужно использовать позиционные обозначения по ГОСТ 2.710-81;

- нумерация формул, рисунков и таблиц сквозная (за исключением приложений).

- Приложения согласно ГОСТ 19.106-78 оформляются без указания их вида. Каждое приложение начинается с новой страницы. Слово «Приложение» с номером (без знака № и без точки на конце) печатается заглавными буквами в правом верхнем углу страницы. Одно приложение не нумеруется. Разделы, формулы, таблицы и рисунки внутри каждого приложения имеют самостоятельную нумерацию.

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

ГРАФИЧЕСКАЯ ЧАСТЬ

Общие положения

Число чертежей, составляющих графическую часть учебного документа, и их содержание определяются в задании на проектирование. Оформление чертежей подчинено соответствующим стандартом. По наиболее необходимым для направления «Информатика и вычислительная техника» графическим документам: схемам электрическим вычислительной техники и схемам алгоритмов и программ ниже приведены выдержки из требований специальных стандартов ЕСКД и ЕСПД. Общие требования, касающиеся форматов чертежей, шрифтов, линий и основной надписи, полностью определяются требованиями ЕСКД.

В данном руководстве требования к оформлению чертежей подразумевают возможность их выполнения средствами машинной графики. Эти средства в настоящее время позволяют в чертежах, имеющих отношение к вычислительной технике, выдержать все требования ЕСКД, а тем более ЕСПД. Прежде всего, это графика Word 6/7/97 и Visio, а также возможно применение других более сложных средств.

Главной трудностью является печать чертежей форматов А1 и А2, т.к. ограниченное число студентов имеют доступ к графопостроителям. Такой способ как печать на принтере чертежей по частям, затем склеивание их в листы форматов А1 и А2 допустим лишь как временная крайняя мера и лишь в случе необходимости, т.к. такой способ не согласуется с требованиями ЕСКД. При этом деление чертежа на части, оформляемые на листах форматов А3 и А4, является более грамотным решением, а для электрических схем или для схем алгоритмов и программделение на части выполняется достаточно просто.

Не следует оформлять графические документы по “смешанной технологии”, дополняя от руки графику, которую удалось не полностью выполнить машинным способом.

Схемы электрические и схемы программ могут располагаться на нескольких листах стандартного формата. Каждый чертеж (не лист ) рассматривается ак самостоятельный документ, имеет основную надпись, представленную на рисунке 1 и подписывается исполнтелем и руководителем. Строки “нормоконтроль” и “утвердил” в чертежах курсовых работ и проектов не заполняются. Форма основной надписи для последующих листов того же чертежа показана на рисунке 2.