Министерство образования и науки МО Государственное автономное профессиональное образовательное учреждение Мурманской области Мурманский колледж экономики и информационных технологий Методические указания для оформления отчёта по учебной практике профессионального модуля ПМ-02 «РАЗРАБОТКА И АДМИНИСТРИРОВАНИЕ БАЗ ДАННЫХ» для специальности 09.02.03 «Программирование в компьютерных системах» ОДОБРЕНА предметной (цикловой) комиссией Информационных технологий Протокол № 3 от 07.12.2017 Автор: Т.В. Комарова 2 СОДЕРЖАНИЕ 1 Требования к отчёту по учебной практике……….…………………………… 4 2 Пояснения по содержанию разделов пояснительной записки……………….. 5 3 Требования к оформлению пояснительной записки………………………….. 8 3.1 Общие положения……………………………………………………………... 8 3.2 Построение документа………………………………………….……………... 8 3.3 Изложение текста документа…………………………………………………. 9 3.4Оформление приложений ……………………………………………………. 9 3.5 Оформление иллюстраций…………………………………………………… 10 3.6 Оформление таблиц………………………………………………................... 10 Приложение А Образец титульного листа…………………………………….. 12 3 1 Требования к отчёту по учебной практике Отчёт по учебной практике должен содержать следующие разделы: 1 Описание постановки задачи 1.1 Характеристика задачи 1.2 Описание выходной информации 1.3 Описание входной информации 2 Организация и ведение информационной базы 2.1 Описание системы кодирования 2.2 Описание внутримашинной базы 3 Описание проектных процедур 4 Алгоритм процедуры 5 Тестовые наборы и тестовые сценарии 6 Руководство пользователя 6.1 Формирование выходного документа Приложение А - Выходные документы Приложение Б - Образцы входных документов Приложение В - Экранные формы 4 2 Пояснения к содержанию разделов отчёта по учебной практике Раздел «Описание постановки задачи»: в подразделе «Характеристика задачи» приводят: 1) наименование и назначение задачи; 2) перечень функций, реализуемых задачей; 3) распределение действий между персоналом при решении задачи; 4) связи данной задачи с другими задачами; подраздел «Описание выходной информации» должен содержать: 1) наименование выходной информации; 2) форма представления (документ или экранная форма) выходной информации; 3) периодичность выдачи (для документа); 4) количество экземпляров (для документа); 5) перечень получателей; 6) ссылку на приложение «Выходные документы»; подраздел «Описание входной информации» должен содержать: 1) наименование входных документов; 2) перечень входной информации; 3) ссылку на приложение «Образцы входных документов». Содержимое разделов «Описание выходной информации» и «Описание входной информации» оформляются в виде таблиц. Раздел «Организация и ведение информационной базы»: в подразделе «Описании системы кодирования» необходимо указать какие системы кодирования записей в таблицах базы данных были использованы, дать их определение и привести примеры кодирования записей в таблицах; подраздел «Описание внутримашинной базы» должен содержать: 1) перечень наименований таблиц базы данных и их описание (оформляется в виде таблицы); 2) описание структуры записей каждой таблицы базы данных: идентификатор поля, наименование поля, тип поля, признак индекса(+) или ключа(*) (оформляется в виде таблицы или рисунком); 3) инфологическая модель БД на языке «Таблицы - Связи» в виде рисунка. Раздел «Описание проектных процедур» Раздел должен содержать описание проектных процедур двух модулей приложения (согласовать с руководителем учебной практики), оформляется в виде таблицы. Таблица 1 - Описание проектных процедур модуля Имя_модуля Имя процедуры Назначение процедуры 5 Раздел «Алгоритм процедуры» Раздел должен содержать блок-схему алгоритма одной из процедур приложения (согласовать с руководителем учебной практики). Наличие в представленном алгоритме всех базовых алгоритмических структур (следование, ветвление, цикл) является обязательным. В этом же разделе необходимо привести программный код процедуры, блок-схема алгоритма которой была представлена. Раздел «Тестовые наборы и тестовые сценарии» Раздел должен содержать описание трёх примеров тестирования приложения. Каждый Test-case должен быть оформлен в таблице, образец которой представлен в таблице 2. Описание информационных полей для тестирования приведено в таблице 3. Таблица 2 - Test case Test Case # Дата тестирования Приоритет теста Название тестирования Резюме испытания Шаги тестирования Данные тестирования Ожидаемый результат Фактический результат Предпосылки Постусловия Статус (Pass/Fail) Комментарии Таблица 3 - Описание информационных полей для тестирования Наименование Описание Дата тестирования Дата когда проводили тестирование Test Case # Уникальный ID для каждого test case. 6 Наименование Описание Приоритет тестирования (Малый/Средний/высокий) Насколько важен этот тест. Приоритет при испытании функционала может быть средним или высоким, в то время как незначительные формы пользовательского интерфейса могут быть с низким приоритетом. Название тестирования/Имя Название тестирования. Например, проверка авторизации с неверным логином или паролем. Резюме испытания Описание, чего нужно достигнуть при тестировании. Шаги тестирования Перечислите детально все шаги тестирования. Напишите в каком порядке должны быть выполнены эти шаги. Убедитесь что вы обеспечили настолько максимальную детализацию насколько можете. Нумерованный список – будет хорошей идей Данные тестирования Напишите тестовые данные используемые для этого тестирования. Данные, которые будут использоваться для проведения тестирования. Например, логин = User4, пароль= User444##444useR Ожидаемый результат Какой должен получится результат после выполнения теста? Опишите подробно ожидаемый результат включая любые сообщения и ошибки, которые должны быть выданы на экран. Фактический результат Какой фактический результат после выполнения теста? Опишите любое соответствующее поведение системы после выполнения тестирования. Предпосылки Любые предварительные действия, которые должны быть выполнены перед проведением тестирования. Перечислите предварительные условия, для успешного выполнения теста Постусловия Какое состояние должно быть у системы после выполнения тестирования? Статус (Pass/Fail) Если фактический результат не соответствует ожидаемым результатам отметка, что тест провалился (fail). В противном случае (pass) Комментарии Используйте эту область для любых дополнительных записей или комментариев. Это область нужна для поддержки полей выше (например есть какие-то особые условия, которые не могут быть описаны ни в одном из полей или есть вопросы связанные с ожидаемыми или фактическими результатами) Раздел «Руководство пользователя» в подразделе «Формирование выходного документа» приводят описание последовательности действий пользователя при работе с программным продуктом для формирования и печати выходного документа с ссылками на пункты меню и экранные формы, приведённые в приложении В. 7 3 Требования к оформлению отчёта по учебной практике 3.1 Общие положения 3.1.1 Текст отчёта оформляется на листах формата А4 в соответствии с общими требованиями к текстовым документам (ГОСТ 2.105 – 95). Нумерация листов отчёта сквозная. Последовательность листов: 1 лист - титульный лист; 2 лист - содержание (листы 1 не нумеруется); 3.1.2 Расстояние от верхней или нижней строки текста до верхней или нижней кромки листа должно быть 20 мм, слева – 25мм, справа – 10 мм. Абзацы в тексте начинают отступом, равным 15 — 17 мм. 3.1.3 Шрифт текста Times New Roman, размер 14 пунктов. Межстрочный интервал 1,5. 3.2 Построение документа 3.2.1 Листы документа нумеруют в пределах всего документа, включая приложения. 3.2.2 Разделы должны иметь порядковые номера в пределах всего документа, обозначенные арабскими цифрами без точки и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой и записываются с абзацного отступа. В конце номера подраздела точка НЕ ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов. 3.2.3 Если документ не имеет подразделов, то нумерация пунктов в нем должна быть в пределах каждого раздела, и номер пункта должен состоять из номеров раздела и пункта, разделенных точкой. В конце номера пункта точка не ставится, например: 1 Типы и основные размеры 1.1 1.2нумерация _ пунктов _ первого _ раздела _ документа 1.3 2 Технические требования 2.1 2.2нумерация _ пунктов _ второго _ раздела _ документа 2.3 3.2.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется. 3.2.5 Внутри пунктов или подпунктов могут быть приведены перечисления. Перед каждой позицией перечисления следует ставить дефис. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа, например: зима; весна; лето: 1) июнь; 2) июль; 3) август; осень. 3.2.6 Каждый пункт, подпункт и перечисление записывают с абзацного отступа. 3.2.7 Разделы, подразделы должны иметь заголовки. Заголовки должны четко и кратко отражать содержание разделов, подразделов. 8 Заголовки следует печатать с прописной буквы без точки в конце, не подчеркивая. Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой. Расстояние между заголовком и текстом должно быть равно 3 интервалам. Расстояние между заголовками раздела и подраздела — 2 интервала. Расстояние между текстом и следующим заголовком должно быть равно 2 интервала. 3.2.8 Каждый раздел текстового документа следует начинать с нового листа (страницы). 3.2.9 Второй лист отчёта является листом содержания, включающим номера и наименования разделов и подразделов с указанием номеров листов (страниц). Слово "Содержание" записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы. 3.2.10 Нумерация страниц документа и приложений, входящих в состав этого документа должна быть сквозная. 3.3 Изложение текста документов 3.3.1 Полное наименование задачи на титульном листе должно совпадать с наименованием задачи в тексте. Наименования, приводимые в тексте документа и на иллюстрациях, должны быть одинаковыми. 3.3.2 Текст документа должен быть кратким, четким и не допускать различных толкований. Порядок слов должен быть прямой, т.е. на первом месте имя прилагательное, имя существительное и т.д. При изложении обязательных требований в тексте должны применяться слова "должен", "следует", "необходимо", "требуется, чтобы", "разрешается только", "не допускается", "запрещается", "не следует". При изложении других положений следует применять слова — "могут быть", "как правило", "при необходимости", "может быть", "в случае" и т.д. Допускается использовать только повествовательную форму изложения текста документа, например "применяют", "указывают" и т.п. 3.3.3 В тексте документа не допускается: применять обороты разговорной речи, техницизмы, профессионализмы; применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке; применять произвольные словообразования; применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе. 3.3.4 В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счёта следует писать цифрами, а числа без обозначения физических величин и единиц счёта – словами. Например: Провести испытания пяти труб, каждая длиной 5 метров. 3.4 0формление приложений 3.4.1 Материал, дополняющий текст документа, допускается помещать в приложениях. Приложениями могут быть, например, графический материал, таблицы большого формата, образцы входных и выходных документов. Приложение оформляют как продолжение данного документа на последующих его листах. 3.4.2 В тексте документа на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте документа. 9 3.4.3 Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова "Приложение" и его обозначения. Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. 3.4.4 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, И, О, Ч, Ь, Ы, Ъ. После слова "Приложение" следует буква, обозначающая его последовательность. В случае полного использования букв русского допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами. Если в документе одно приложение, оно обозначается "Приложение А". 3.4.5Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц. 3.4.6 Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их обозначений и заголовков. 3.6 Оформление иллюстраций 3.6.1 Иллюстрации могут быть расположены как по тексту документа так и в приложениях. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается "Рисунок 1". 3.6.2 Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например — Рисунок А.4. 3.6.4 При ссылках на иллюстрации следует писать "... в соответствии с рисунком 2" при сквозной нумерации и "... в соответствии с рисунком А.4" при нумерации внутри приложения. 3.6.5 Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и располагают под рисунком симметрично тексту следующим образом: Рисунок 1 — Иерархия меню 3.7 Оформление таблиц 3.7.1 Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы должно отражать ее содержание, быть точным и кратким. Название следует помещать над таблицей с абзацного отступа, как показано на рисунке 1. Таблица ______ номер ____________________ название таблицы Заго ловки граф Строки (горизонтальные ряды) Боковик Графы (колонки) (графа для заголовка) Рисунок 1 Пример оформления таблицы 10 3.7.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена "Таблица 1" или "Таблица Б.1", если она приведена в приложении Б. 3.7.3 На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово "таблица" с указанием ее номера. 3.7.4 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф — со строчной буквы. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе и выделяют жирным шрифтом. 3.7.5 Таблицы слева, справа и снизу, как правило, ограничивают линиями. Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается. Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускаются. Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф. Головка таблицы должна быть отделена линией от остальной части таблицы. Высота строк таблицы должна быть не менее 8 мм. 3.7.6 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а, при необходимости, в приложении к документу. Допускается помещать таблицу вдоль длинной стороны листа документа. 3.7.7 Если строки таблицы выходят за формат страницы, ее делят на части, при этом в каждой части таблицы повторяют ее головку. Если графы таблицы выходят за формат страницы, ее делят на части, при этом в каждой части таблицы повторяют ее боковик. При переносе части таблицы на другие страницы название помещают только над первой частью таблицы. Слово "Таблица" указывают один раз слева над первой частью таблицы, над другими частями пишут слова "Продолжение таблицы" с указанием номера (обозначения) таблицы. Если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, не проводят. 3.7.8 Графу "Номер по порядку" в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части. 3.7.9 Если в графе таблицы помещены значения одной и той же физической величины, то обозначение единицы физической величины указывают в заголовке (подзаголовке) этой графы. 3.7.10 Текст, повторяющийся в строках одной и той же графы при первом повторении его заменяют словами "То же", а далее кавычками, если в таблице отсутствуют горизонтальные линии, разделяющие строки. При наличии горизонтальных линий текст необходимо повторять в каждой строке. 3.7.11 При отсутствии отдельных данных в таблице следует ставить прочерк (тире). 3.7.12 При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, их следует записывать: "От ... до ... включ." или между крайними числами ряда в таблице допускается ставить тире. 3.7.13 Цифры в графах таблиц должны проставляться так, чтобы разряды чисел во всей графе были расположены один под другим, если они относятся к одному показателю. В одной графе должно быть соблюдено, как правило, одинаковое количество десятичных знаков для всех значений величин. 11 Приложение А Образец титульного листа Министерство образования и науки Мурманской области ГАПОУ МО «МКЭиИТ» Отделение: дневное Специальность: 09.02.03 «Программирование в компьютерных системах» ОТЧЁТ по учебной практике профессионального модуля ПМ-02 «РАЗРАБОТКА И АДМИНИСТРИРОВАНИЕ БАЗ ДАННЫХ» РАЗРАБОТАЛ студент группы 3П1 П. И. Иванов ПРОВЕРИЛ преподаватель Т. В. Комарова Оценка: _______ 20__ 12
