Главная | Обратная связь | Поможем написать вашу работу!
МегаЛекции

Изложение текста документов

Мурманский колледж экономики и информационных технологий

 

 

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

для оформления контрольной работы

 

по разделу «Разработка приложений в Delphi»

МДК 03.02 профессионального модуля ПМ-03

«УЧАСТИЕ В ИНТЕГРАЦИИ ПРОГРАММНЫХ МОДУЛЕЙ»

 

для специальности
09.02.03 «Программирование в компьютерных системах»

 

 

 

 


СОДЕРЖАНИЕ

 

1 Требования к контрольной работе………………….…………………………………  
   
2 Пояснения по содержанию разделов ………………………….……………………..  
   
3 Требования к оформлению ………………………….………………………………..  
   
3.1 Общие положения…………………………………………………………………...  
   
3.2 Построение документа……………………………………………….……………...  
   
3.3 Изложение текста документа……………………………………………………….  
   
3.4 Оформление формул……………………………………………………...................  
   
3.5 Оформление приложений …………………………………………………………….  
   
3.6 Оформление иллюстраций……………………………………………………………  
   
3.7 Оформление таблиц………………………………………………………...................  
  Приложение А Образец титульного листа……………………………………………..  

 


Требования к контрольной работе

 

 

Контрольная работа должна содержать следующие разделы:

 

1 Формулировка задания

2 Спецификация программы

2.1 Описание функций программы

2.2 Описание выходной информации

2.3 Описание входной информации

2.4 Описание исключительных ситуаций

3 Функциональная структура программы

4 Описание проектных процедур

5 Тестовые наборы и тестовые сценарии

Приложение А Выходные документы

Приложение Б Экранные формы

Пояснения к содержанию разделов

 

Раздел «Формулировка задания»

 

Например: Разработайте в среде Delphi приложение, позволяющее работать с типизированным файлом путём выбора соответствующего пункта меню. Типизированный файл должен содержать информацию о поступлении товаров на склад: дата поступления, поставщик, название товара, цена, количество. Условие для просмотра – товар от выбранного поставщика. Условие для печати – поступление товаров за определённую дату. Документ – товарная карточка.

 

Раздел «Спецификация программы»

 

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

Спецификация программы включает: назначение программы с описанием всех функций, описание входных данных, описание формы представления результатов при допустимых входных данных, описание исключительных ситуаций при вводе входных данных и реакции программы на них.

- подраздел «Описание выходной информации» должен содержать:

1) наименование выходной информации;

2) форма её представления (если «экранная форма», то в каком компоненте осуществляется отображение выходных данных: данные выводятся в таблицу StrinGrid, или в редактор Memo, или в строку Edit…; или «печатный документ»);

- подраздел " Описание входной информации " должен содержать:

1) наименование входной информации;

2) компонент для ввода данных;

3) тип данных.

Рекомендуется «Описание выходной информации» и «Описание входной информации» оформлять в виде таблиц.

- в подразделе «Описание исключительных ситуаций» приводится:

1) описание возможных исключительных ситуаций;

2) перечень диагностических сообщений с указанием ситуации их появления.

 

Раздел «Функциональная структура программы»

 

Раздел «Функциональная структура программы» должен содержать рисунок – схему взаимосвязи функций, реализуемых в программе, с указанием модулей, в которых эти функции задачи реализованы.

Кроме рисунка-схемы, в этом разделе должно быть приведено описание модулей (Unit2), которые не задействованы в рисунке-схеме.

 

Раздел «Описание проектных процедур»

 

Описание проектных процедур оформляется в виде таблицы.

 

Таблица 1 - Описание проектных процедур

Имя модуля Имя процедуры Назначение процедуры
     

 

 

Раздел «Тестовые наборы и тестовые сценарии»

 

Раздел «Тестовые наборы и тестовые сценарии» должен содержать описание действий пользователя программы, необходимых для получения выходной информации, с ссылками на экранные формы ввода и вывода информации, представленные в приложении Б.

 


Требования к оформлению

 

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

 

3.1.1 Текст отчёта оформляется на листах формата А4 в соответствии с общими требованиями к текстовым документам (ГОСТ 2.105 – 95). Нумерация листов сквозная. Последовательность листов:

1 лист - титульный лист (нумерация на листе не ставится);

2 лист - содержание (нумеруется номером 2);

3.1.2 Размеры полей: верхнего и нижнего 20 мм, левого – 25мм, правого – 10 мм. Абзацы в тексте начинают отступом, равным 15 мм.

3.1.3 Шрифт текста Times New Roman, размер 14 пунктов. Межстрочный интервал 1,5. Интервалы перед и после абзаца должны быть равны 0 пт. Выравнивание текста по ширине.

 

Построение документа

 

3.2.1 Текст документа при необходимости разделяют на разделы и подразделы.

Листы документа нумеруют в пределах всего документа, включая приложения.

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

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

1 Типы и основные размеры

2 Технические требования

 

3.2.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется.

3.2.5 Внутри пунктов или подпунктов могут быть приведены перечисления.

Перед каждой позицией перечисления следует ставить ДЕФИС. Для дальнейшей детализации перечислений необходимо использовать АРАБСКИЕ ЦИФРЫ, после которых ставится скобка, а запись произво­дится с абзацного отступа. Элементы перечисления должны записываться со строчной буквы. Каждый элемент перечисления заканчивается точкой с запятой, после последнего элемента ставится точка. Например:

Сезоны года:

- зима:

1) декабрь;

2) январь;

3) февраль;

- весна;

- лето;

- осень.

3.2.6 Каждый пункт, подпункт и перечисление записывают с абзацного отступа.

3.2.7 Разделы, подразделы должны иметь заголовки. Заголовки должны четко и кратко отражать содержание разделов, подразделов.

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

Расстояние между заголовком и текстом должно быть равно 3 интер­валам. Расстояние между заголовками раздела и подраздела — 2 интервала. Расстояние после текста до нового подраздела должно быть равно 2 интервала.

3.2.8 Каждый раздел текстового документа следует начинать с нового листа (страницы).

3.2.9 Второй лист отчёта является листом содержания, включающим номера и наименования разделов и подразделов с указанием номеров листов (страниц).

Слово "Содержание" записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы.

3.2.10 Нумерация страниц документа и приложений, входящих в состав этого документа должна быть сквозная.

 

Изложение текста документов

 

3.3.1 Наименования, приводимые в тексте документа и на иллюстра­циях, должны быть одинаковыми.

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

Допускается использовать только повествовательную форму изложения текста документа, например "применяют", "указывают" и т.п.

3.3.3 В тексте документа не допускается:

- применять обороты разговорной речи, техницизмы, профессионализмы;

- применять произвольные словообразования;

- применять сокращения слов.

3.3.4 В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счёта следует писать цифрами, а числа без обозначения физических величин и единиц счёта – словами. Например: Провести испытания пяти труб, каждая длиной 5 метров.

Формление приложений

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

Приложение оформляют как продолжение данного документа на последующих его листах.

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

3.4.3 Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова "Приложение" и его обозначения.

Приложение должно иметь заголовок, который записывают симмет­рично относительно текста с прописной буквы отдельной строкой.

3.4.4 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, И, О, Ч, Ь, Ы, Ъ. После слова "Приложение" следует буква, обозначающая его последовательность.

Если в документе одно приложение, оно обозначается "Прило­жение А".

3.4.5 Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц.

3.4.6 Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их обозначений и заголовков.

 

Оформление иллюстраций

 

3.5.1 Иллюстрации могут быть расположены как по тексту документа так и в приложениях. Иллю­страции, за исключением иллюстраций приложений, следует нуме­ровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается "Рисунок 1".

3.5.2 Иллюстрации каждого приложения обозначают отдельной нуме­рацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например — Рисунок А.4.

3.5.4 При ссылках на иллюстрации следует писать "... в соответствии с рисунком 2" при сквозной нумерации и "... в соответствии с рисунком А.4" при нумерации внутри приложения.

3.5.5 Иллюстрации, должны иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование располагают под рисунком симметрично тексту следующим образом: Рисунок 1 — Иерархия меню

 

 

Оформление таблиц

3.6.1 Таблицы применяют для лучшей наглядности. Название таблицы должно отражать ее содержание, быть точным и кратким. Название следует помещать над таблицей с абзацного отступа, как показано на рисунке 1.

 

Таблица ______ - ____________________

номер название таблицы

 

       
         
         
           
           

Заго

ловки

граф

 

Строки (горизонтальные ряды)

 


Боковик Графы (колонки)

(графа для заголовка)

 

Рисунок 1 - Пример оформления таблицы

 

 

3.6.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.

Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена "Таблица 1" или "Таблица Б.1", если она приведена в приложении Б.

3.6.3 На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово "таблица" с указанием ее номера.

3.6.4 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф — со строчной буквы. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе и выделяют жирным шрифтом.

3.6.5 Таблицы слева, справа и снизу, как правило, ограничивают линиями.

Разделять заголовки и подзаголовки боковика и граф диагональ­ными линиями не допускается.

Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускаются.

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

Головка таблицы должна быть отделена линией от остальной части таблицы.

Высота строк таблицы должна быть не менее 8 мм.

3.6.6 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а, при необходимости, в приложении к документу.

Допускается помещать таблицу вдоль длинной стороны листа документа.

3.6.7 Если строки таблицы выходят за формат страницы, ее делят на части, при этом в каждой части таблицы повторяют ее головку.

Если графы таблицы выходят за формат страницы, ее делят на части, при этом в каждой части таблицы повторяют ее боковик.

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

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

3.6.8 Графу "Номер по порядку" в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части.

3.6.9 Если в графе таблицы помещены значения одной и той же физической величины, то обозначение единицы физической величины указывают в заголовке (подзаголовке) этой графы.

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

При наличии горизонтальных линий текст необходимо повто­рять в каждой строке.

3.6.11 При отсутствии отдельных данных в таблице следует ставить прочерк (тире).

3.6.12 При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, их следует записывать: "От... до... включ." или между крайними числами ряда в таблице допускается ставить тире.

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

 

 


Приложение А

Образец титульного листа

 

 

Министерство образования и науки Мурманской области

 

ГАПОУ МО «МКЭиИТ»

 

 

Отделение: заочное

 

Специальность: 09.02.03 «Программирование в компьютерных системах»

 

 

КОНТРОЛЬНАЯ РАБОТА

по разделу «Разработка приложений в Delphi» МДК 03.02

 

профессионального модуля ПМ-03

«УЧАСТИЕ В ИНТЕГРАЦИИ ПРОГРАММНЫХ МОДУЛЕЙ»

 

 

РАЗРАБОТАЛ ПРОВЕРИЛ

студент группы 3ПЗ1 преподаватель

П. И. Иванов Т. В. Комарова

 

Оценка: _______

 

Дата: _________

 

Поделиться:





Воспользуйтесь поиском по сайту:



©2015 - 2024 megalektsii.ru Все авторские права принадлежат авторам лекционных материалов. Обратная связь с нами...