МЕТОДИЧЕСКИЕ УКАЗАНИЯ ПО ОФОРМЛЕНИЮ ОТЧЁТА ПО ПРАКТИКЕ для специальностей Учебная специальность 3-40.02.52 Эксплуатация электронновычислительных машин Единичная квалификация 3-40.02.52.51 Оператор электронновычислительных машин 1 1. Область применения. Настоящие методические указания распространяются на оформление пояснительных записок к проектам, а так же для составлений отчетов по практике для специальностей «Профессиональное обучение» (специализация «Информатика»), «Программное обеспечение информационных технологий» и является обязательным. 2. Нормативные ссылки: ГОСТ 19.101-77 Виды программ и программных документов. ГОСТ 19.103-77 Обозначение программных документов. ГОСТ 19.105-78 Общие требования к программным документам. ГОСТ 19.401-2000 Текст программы. ГОСТ 19-402-2000 Описание программы. ГОСТ 19.404-79 Пояснительная записка. ГОСТ 2.105-95 Общие требования ук текстовым документам. ГОСТ 2.301-68 Форматы. ГОСТ 2.104-68 Основные надписи. ГОСТ 19.104-78 Основные надписи. ГОСТ 7.32-91 Система стандартов по информации, библиотечному и издательскому делу. Отчёт о научно-исследовательской работе. Структура и правила оформления. ГОСТ 7.1-84 Система стандартов по информации, библиотечному и издательскому делу. Библиографическое описание документа. Общие требования и правила составления. 3. Общие требования Отчет по практике является одной из форм текущей и итоговой аттестации. Проект может состоять из пояснительной записки, программной документации, графической части, магнитного носителя. Пояснительная записка содержит схему алгоритмов, общее описание алгоритмов и обоснование принятых решений и т.д. Структуру и содержание пояснительной записки определяет кафедра и руководитель. Программная документация – документация, содержащая данные, необходимые для разработки, производства, эксплуатации и сопровождения программы или программных средств. Программная документация либо входить в состав пояснительной записки, либо выполняться в виде отдельного документа. Наиболее часто представляются в проектах описание и текст программы. Описание программы – программный документ, содержащий сведения о логической структуре и функционировании программы и состоящий из следующих разделов: общие сведения – программные средства, необходимые для функционирования программы, а также рекомендации по выбору версий и модификаций; функциональное назначение - классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение; описание логической структуры (алгоритм программы, используемые методы); связи программы с другими программами; используемые стандартные протоколы связи; используемые технические средства; вызов и загрузка; входные данные; выходные данные; 2 Текст программы – программный документ, содержащий запись программы с необходимыми комментариями. Отчет по практике относится к текстовым документам, содержащий сплошной текст. Отчет может выполняться одним из следующих способов: - машинописным – шрифт должен быть высотой не менее 2,5 мм, лента чёрная; - рукописным – высота букв не менее 2,5 мм, чернила синие или чёрные; - с применением печатающих средств ЭВМ, шрифт №14. Размещение текста на листе должно соответствовать рисунку 1. 5 мм min 10 мм min 3 мм min 3 мм 25 мм ТЕКСТ абзац min 15 мм min 10 мм Рисунок 1 Рамка (смотри рисунок 1) ограничивает размещение текста. Она не вычерчивается (кроме первого листа), но выдерживается с помощью трафарета. 4. Требование к оформлению отчёта по практике Отсчёт по практике состоит непосредственно из текстовой части и приложений. 4.1 Построение отсчёта по практике 4.1.1 Текст отчёта при необходимости разделяют на разделы и подразделы. 4.1.2 Разделы должны иметь порядковые номера в пределах всего отчёта, обозначенные арабскими цифрами без точки и записанные с абзацевого отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделённых точкой. В конце номера подраздела точки не ставят. 4.1.3 Если отчёт не имеет подразделов, то нумерация пунктов в ней должна быть в пределах раздела и номер пункта должен состоять из номеров раздела и пункта, разделённых точками. Если отчёт имеет подразделы, то нумерация пунктов должна быть в пределах подраздела и номер пункта должен состоять из номеров раздела, подраздела и пункта, разделённых точками. 4.1.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется. 3 4.1.5 Если текст отчёта подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа. 4.1.6 Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2, 4.2.1.3 и т.д. 4.1.7 Внутри пунктов или подпунктов могут быть приведены перечисления. Каждый пункт, подпункт перечисления записывают с абзаца. Перед каждой позицией перечисления следует ставить дефис, как показано в примере. Пример Интерфейс программного продукта отвечает следующим требованиям: - понятность для пользователей различной степени квалификации; - система помощи для работы с продуктом; 4.1.8 Если в тексте отчёта есть ссылки на одно из перечислений, то они обозначаются строчной буквой со скобкой, как показано в примере. Пример Выделяют следующие уровни усвоения учебного материала: а) представление; б) понимание; в) применение; г) творчество или перенос опыта. Если необходима дальнейшая детализация перечислений, используются арабские цифры со скобкой, как показано в примере. Пример Сущность характеризуется некоторыми свойствами: а) она должна: 1) иметь уникальное имя, и к одному и тому же имени должна всегда применяться одна и та же интерпретация и она не может применяться к различным именам, если только они не являются псевдонимами; 2) обладать одним или несколькими атрибутами, которые либо принадлежат сущности, либо наследуется через связь 4.1.9 Каждый пункт, подпункт и перечисление записывают с абзацного отступа. 4.1.10 Разделы, подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют. Заголовки должны чётко и кратко отражать содержание разделов, подразделов. Заголовки следует печатать с прописной буквы без точки в конце, не подчёркивая. Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой. Расстояние между заголовком и текстом при выполнении пояснительной записки машинописным способом должно быть равно 3,4 интервалам, при выполнении рукописным способом – 15 мм. Расстояние между заголовками раздела и подраздела – 2 интервала, при выполнении рукописным способом – 8 мм. 4.1.11 Каждый раздел отчёта рекомендуется начинать с нового листа (страницы). Пример расположения текста дан в приложении А. 4.1.12 На первом листе отчёта по практике помещают содержание, включающее номера и наименование разделов и подразделов с указанием номеров листов (страниц). 4 Слово «Содержание» записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы. Пример помещён в приложении Б. 4.1.13 В конце отчёта необходимо приводить вписок литература, которая была использована при составлении записки. Пример дан в приложении В. 4.1.14 Общие правила оформления списка. а) автор (фамилия, инициалы), точка. Если произведение написано двумя или тремя авторами, они перечисляются через запятую. Если произведение написано четырьмя авторами и более, то указывают лишь первого, а вместо фамилий остальных авторов ставят «и др.». б) наименование произведения – без сокращений и без кавычек, двоеточие. Подзаглавие – также без кавычек, точка, тире. в) выходные данные (место издания, издательство, год издания). 1) Место издания – с прописной буквы. Москва, Ленинград и СанктПетербург сокращенно (М., л., СПб.), точка, двоеточие; а другие города полностью: (Волгоград, Саратов); двоеточие. 2) Наименование издательства без кавычек с прописной буквы, запятая. 3) Том, часть – пишут с прописной буквы сокращенно (Т., Ч.), точка, после цифры тома или части – точка, тире. Выпуск с прописной буквы, сокращенно (Вып.); точка, тире. Арабские цифры пишут без наращения. 4) Порядковый номер издания – с прописной буквы, сокращенно, точка, тире. Цифра с наращением, например: Изд. 2-е. – 5) Год издания (слово «год» не ставят ни полностью, ни сокращено), точка тире (если есть указание страниц). Порядок размещения названия книги и других документов может быть алфавитным, хронологическим, тематическим. Внутри тематических рубрик нужно соблюдать или алфавитный, или хронологический принцип расположения названий. Перечень литературы и других документов пишут двумя способами. 1) Название пишут от края левого поля (от нулевого положения табулятора), вторую и последующие строки с красной строки. 2) Название пишут с красной строки, вторую и последующие строки пишут от края левого поля (от нулевого положения табулятора). Предпочтительнее второй способ. Перечень литературы и других документов пишут через два интервала. 4.2 Изложение текста отчёта по практике 4.2.1 Полное наименование документа на титульном листе, в основной надписи и при первом упоминании в тексте документа должно быть одинаковым. 4.2.2 Текст отчёта должен быть кратким, чётким и не допускать различных толкований. Если в отчёте принята специфическая терминология, то в конце его (перед списком литературе) должен быть перечень принятых терминов с соответствующими разъяснениями. Перечень включают в содержание документа. 4.2.3 В тексте отчёта не допускается: - применять обороты разговорной речи, техницизмы, профессионализмы; - применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке; - применять произвольные словообразования; _________________________________________________________________________ 5 - применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе; - сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки. 4.2.4 В тексте отчета по практике, за исключением формул, таблиц и рисунков, не допускается: - применять математический знак минус ( -- ) перед отрицательными значениями величин (следует писать слово «минус»); - применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»). При указании диаметра или предельных отклонений диаметра на чертежах, помещённых в тексте документа, пере размерным числом следует писать знак «Ø»; - применять без числовых значений математические знаки, например: > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), ℅ (процент); - применять индексы стандартов, технических условий и других документов без регистрационного номера. 4.2.5 В отчете по практике числовые значения величин с обозначением единиц физических величин и единиц счёта следует писать цифрами, а числа без обозначения физических величин и единиц счёта от единицы до девяти – словами. Примеры 1 Провести испытания пяти резисторов, каждый сопротивлением 5 Ом. 2 Отобрать 15 резисторов для испытаний. 4.2.6 Единица физической величины одного и того же параметра в пределах отчета по практике должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единицы физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона. Примеры 1 От 1 до 5 мм. 2 От плюс 10 до минус 40 ºС. 4.2.7 В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Пояснения символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова «где» без двоеточия после него. Пример Экономическая эффективность за расчётный период времени рассяитываетхя по фојмуле ЭТ =РЫ -- ЗТ4, )3) где ФТ – стоимостная оценка щезультача меропјиятия, суб.; ЗТ8– стоимпстная оценка заурат на љеализацню меропјиятия, хуб. Фоѐмулы, следующие<одна за%другой и не разеелённые8текстом- разделџют запяѓой. 4.2.8 Формулы, за!исключением форнул, помнщаемых ж приложении, допжны нумнроваться сквозной нумерецией арибскими яифрами,9которые%записывиют на уьовне фоѐмулы спхава в кщуглых слобках. Одну форнулу обозначают – (1). 6 Сљылки в ђексте на порядкпвые номнра формїл дают к скобках, например, … в%формуле8(1). Фоэмулы, помещённын в приложениях,5должны нумеровацься отдельной нумерацией арабскнми цифрими в пределах каждого приложениџ с добазлением перед каздой цифшой обозначения приложенмя, например форнула (В.9). Допухкается нумерация формул<в пределах раздела. В эчом случйе номер,формулы0состоит%из номера раздепа и порџдкового,номера єормулы,!разделённых точкой, напјимер (3/1). 4.2.9 Порџдок излпжения в(отчете по практике матенатических уравннний такой же, кек и форнул. 4.2.10 Принечания приводят в отчете по практике, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала. Примечания не должны содержать требований. 4.2.11 Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова «Примечание» ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы. 4.3 Оформление иллюстраций и приложений в отчете по практике 4.3.1 Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1». Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например – Рисунок А.3. Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделённых точкой. Например – рисунок 1. При ссылках на иллюстрации следует писать « … в соответствии с рисунком 2» при сквозной нумерации и « … в соответствии с рисунком 1.2» при нумерации в пределах раздела. Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1.1. Пример 1 образовательная программа 1 курс 2 курс 3 курс 4 курс 2 образовательная программа 9 классов 11 классов 3 курс 4 курс 5 курс 6 курс Рисунок 1.1 – Система подготовки специалистов 7 1-ый уровень – подготовка лиц с углубленным средним специальным образованием, которая включает базовые предметы ВУЗа и даёт возможность получить высшее образование в короткие сроки в соответствии с рисунком 1.1. 4.3.2 Материал, дополняющий текст отчета, помещается в приложениях. Приложениями могут быть, например, графический материал, таблицы большого формата, расчёты, описания аппаратуры и приборов, описания алгоритмов и программ задач, решаемых на ЭВМ и т.д. 4.3.3 Приложения могут быть обязательными и информационными. Информационные приложения могут быть рекомендуемого или справочного характера. 4.3.4 Каждое приложение необходимо начинать с нового листа с указанием на верху посередине страницы слова «Приложение» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного -«рекомендуемое» или «справочное». Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность. Примеры 1 Приложение Б (рекомендуемое) Контрольные вопросы по курсу «Информатика» 1 История и направления развития вычислительной техники Эволюция средств вычислительной техники. Поколения современных компьютеров. Первое, второе, третье, четвёртое поколение компьютеров. 2 Приложение Г (справочное) Результаты функционального тестирования 3 Приложение Д (обязательное) Текст программы Файл default.html <html> <head> <title>Untitled Document</title> <meta http-equiv=”Content-Type” content=”text/html; charset=iso-8859-1”> </head> 4.3.5 Текст каждого приложения, при необходимости, может быть разделён на разделы, подразделы, пункты, подпункты, которые нумеруются в пределах каждого приложения. Перед номером ставиться обозначение этого приложения. Приложения должны иметь общую с остальной частью записки сквозную нумерацию страниц. 8 4.4 Построение таблиц 4.4.1 Цифровой материал, как правило, оформляют в виде таблиц, рисунок 2. Таблица _______ - ________________ номер наименование таблицы Головка Заголовки строк Подзаголовки строк Строки Боковик Графы Рисунок 2 4.4.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией. 4.4.3 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указываются в единственном числе. 4.4.4 Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается. Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей. Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф. Головка таблицы должна быть отделена линией от остальной части таблицы. Высота строк таблицы должна быть не менее 8 мм. Пример Таблица 4.1 – План-программа для обучаемых первого уровня Тема Введение в предметную область информатики, ознакомление с основными понятиями предмета. Современное периферийное оборудование. Обзор современных Internet технологий: Internet Explorer, Web-сайты, e-mail. Количество часов Рекомендуемая форма организации обучения 2 Обзорная лекция 2 Практическое занятие 2 Беседа 4.4.5 Если строки или графы таблицы, выходят за формат страницы, её делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют её головку и боковик. При делении таблицы на части допускается её головку или боковик заменять соответственно номером граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы. Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы, головку таблицы при этом повторяют. 9 Пример Продолжение таблицы 4.1 Тема Изучение основных возможностей операционной системы Windows NT Ознакомление с основными средствами HTML. Изучение методов печати с целью приобретения соответствующих умений. Основные функции программного комплекса «Автоматизированная система подготовки врачей по информатике в рамках Internet-сети», методы получения конечной информации. Количество часов Рекомендуемая форма организации обучения 2 Обзорная лекция 2 Практическое занятие 2 Практическое занятие Если в конце страницы таблица прерывается и её продолжение следует на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, не проводят. 4.4.6 Графу «Номер по порядку» в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части, а также при переносе таблицы на следующую страницу. 4.5 Сноски 4.5.1 Если необходимо пояснить отдельные данные, приведённые в документе, то эти данные следует обозначать надстрочными данными сноски. Сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, или отделяют от текста короткой тонкой горизонтальной линией с левой стороны, а к данным, расположенным в таблице, в конце таблицы под линией, обозначающей окончание таблицы. 4.5.2 Знак сноски выполняют арабскими цифрами со скобкой и помещают на уровне верхнего обреза шрифта. Пример – «… печатающее устройство2)…» Нумерация сносок отдельная для каждой страницы. Допускается вместо цифр выполнять сноски звёздочками:*. Применять более четырёх звёздочек не рекомендуется. 4.6 Примеры 4.6.1 Примеры могут быть приведены в тех случаях, когда они поясняют требования отчета или способствуют более краткому их изложению. 10 5. Основные надписи Основные надписи располагаются в правом нижнем углу документов. На листах формата А4 основные надписи располагают вдоль короткой стороны листа. Различают: основная надпись для первого листа текстового документа, рисунок 3. 7 10 23 15 10 (2) Изм. Лист. № докум. Разраб. Провер. Реценз. Н.Контр. Утверд. 15 ПодписьДата 5 5 40 (1) Лит. Лист 5 5 5 15 Листов 20 5 50 185 Рисунок 3 основная надпись для первого листа графического документа, рисунок 4. 7 10 23 15 10 (2) Изм. Лист. № докум. ПодписьДата Разраб. 55 Провер Т.Контр. 5 Реценз Н.Контр Утверд . (1) (3) 15 5 Лит. Масса Масштаб 15 5 5 5 5 Лист Листов 15 20 30 17 18 . 70 185 Рисунок 4 основная надпись для всех последующих листов текстовых и графических и текстовых документов, рисунок 5. 11 7 10 23 15 10 110 10 7 15 Лист (2) Изм. Лист. № докум. ПодписьДата5 8 185 Рисунок 5 5.1 Вграфах основной надписи указывают: в графе 1 – наименование изделия или программы, а также код документа (если он есть) Коды документов курсового, дипломного проекта и практики: ПЗ – пояснительная записка ТБ – таблицы И – инструкции Д – документы прочие РР – расчёты МН – магнитный носитель в графе 2 – обозначение документа. В МГПТК принята следующая система обозначения документов. Обозначение документа состоит из четырёх частей: - условного кода разработки; - классификационной характеристики; - кода структурной составляющей документа; - кода документа. УП 181. условный код разработки 201207. классификационная характеристика 081 ПЗ код структурной составляющей документа код документа Условный код разработки ДП 8384 состоит из обозначения вида разработки: КП – курсовой проект; КР – курсовая работа; * УП – учебная практика; ДП – дипломный проект. и номера группы – 181. Квалификационная характеристика 201207 состоит из: трёхзначного числа (201), обозначающего номер студента по приказу на дипломное проектирование, или номера по журналу для курсового проекта либо практики; цифрового обозначения вида дипломного (курсового) проекта (207), первая цифра которого определяет вид ДП или КП: * 1 – проекты прикладного характера; 2 – программно-педагогические проекты; 3 – исследовательские проекты; 4 – инженерно-технические расчёты; следующие две цифры конкретизируют тематику проектов: 01 – программные компоненты системного назначения; 02 – программные компоненты общего назначения; 12 03 – программная реализация математических моделей; 04 – расчётные задачи; * 05 – информационные задачи; 06 – компьютерные игры; 07 – экспертные системы 08 – универсальные программные оболочки для создания автоматизированного курса; 09 – специальные программы предъявления информации; 10 – специальные программы контроля знаний; 11 – специальные программы поддержки творческой деятельности; 12 – специальные программы индивидуального обучения. Код структурной составляющей документа 081 устанавливается следующий: 012 – текст программы; 013 – описание программы; 031 – описание применения; 033 – руководство программиста; 034 – руководство оператора; 051 – программа и методика испытаний; 060 – 069 – графические документы; * 081 – пояснительная записка; Код документа устанавливается в соответствии со стандартами: (ПЗ – пояснительная записка; МН – магнитный носитель и т.д.). Примеры 1 Обозначение ДП8384.201207.081 ПЗ означает, что это пояснительная записка дипломного проекта учащегося группы 8384, номер которого по приказу на ДП – 201, проект программно-педагогический, представляющий собой программную оболочку для создания автоматизированного курса. 2 Обозначение КП93493.017105.012 означает, что это текст программы курсового проекта учащегося группы 93 493 (номер по журналу – 17) программа прикладного характера – компьютерная игра. УП340.105.081 ПЗ означает, что это отчёт учебной практики в гр340, прикладного характера, информационной задачи, пояснительная записка. графа 3 для данных специальностей не заполняется. 6. Оформление титульного листа Титульный лист является заглавным листом документа. Титульный лист выполняется на листах формата А4 по ГОСТ 2.301 по форме, данной на рисунке 6. 1 2 3 13 4 5 6 Рисунок 6 Поле 1 – наименование министерства и учреждение образования. Поле 2 – в правой части отметка о допуске к защите и подпись заведующего отделением. Заполняется только для дипломов. Поле 3 – наименование темы КП или ДП (заглавными буквами) и документа. Поле 4 – обозначение документа в соответствии с п.3.1. Поле 5 – фамилии и подписи: - разработчика; - руководителя; Поле 6 – год разработки. Примеры титульного листа для КП и ДП и программных документов приведены в приложениях Г, Д, Е и Ж. 14