Учебное пособие по выполнению и оформлению курсовых, дипломных и квалификационных работ москва 2002 2 аннотация
 Скачать 0.53 Mb.
|
|
Оформление текстов программ Тексты программ должны оформляться в соответствии с «хорошим стилем» про- граммирования, т.е. должны быть легко читаемы и хорошо документированы. В тек- стах должны быть комментарии: 1) после заголовка программы или подпрограммы – общая информация: назначе- ние, входные данные, результаты, метод решения; данные о программисте, дата напи- сания, версия; 2) при объявлении данных - назначение переменных; 3) в начале и в конце определенной функционально законченной части программы; 4) для пояснения логических частей программы (ветвлений, циклов). Однако, комментарии не должны затенять структуру текста и должны быть ясными и краткими. Наименование программ и подпрограмм должны отражать их назначение. Логиче- ская структура программы должна быть отражена в ее тексте с помощью: 1) пустых строк между текстами подпрограмм и отдельных ее функционально за- конченных частей; 2) сдвигами текста в строке при написании: • заголовков вложенных циклов; • тела цикла после его заголовка; • альтернатив разветвлений процесса обработки данных. 65 Оформление приложений Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т.д. Например: ПРИЛОЖЕНИЕ 2. Титульный лист расчетно-пояснительной записки. Рисунки и таблицы, помещаемые в приложении, нумеруются арабскими цифрами в пределах каждого приложения с добавлением буквы «П». Например: рис. П.12 – 12-й рисунок приложения; рис. П1.2 – 2-й рисунок 1-го приложения. Каждый файл в приложении оформляется как рисунок с наименованием файла и его назначением. Например: Рис. П1.3. Файл mod1.pas – исходные тексты библиотеки процедур обработки. Рис. П2.4. Фал menuran.pas – программа движения курсора основного меню. Оформление списка литературы Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т.д.) должны содержать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год изда- ния. При наличии трех и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.». Наименование места издания надо приводить полностью в именительном падеже: допускается сокращение названия только двух го- родов: Москва (М.) и Санкт-Питербург (СПб.). Сведения о статье из периодического издания должны включать: фамилию и ини- циалы автора, наименование статьи, наименование издания (журнала), наименование серии, если она есть, год выпуска, том, если есть, номер издания (журнала) и номера страниц, на которых помещена статья. При ссылке на источник из списка литературы (особенно при обзоре аналогов) на- до указывать порядковый номер по списку литературы, заключенный в квадратные скобки; например: [5]. 66 СПИСОК ЛИТЕРАТУРЫ 1. Буч Г., Рамбо Д., Джакобсон А. Язык UML. Руководство пользователя. М.: ДМК Пресс, 2001. 2. Иванова Г.С. Технология программирования. М.: Из-во МГТУ им. Баумана, 2002. 3. Иванова Г.С., Ничушкина Т.Н., Пугачев Е.К. Объектно-ориентированное про- граммирование. М: Из-во МГТУ им. Баумана, 2001. 4. Кватрани Т. Rational Rose и UML. Визуальное моделирование. М.: ДМК Пресс, 2001. 5. Ларман К. Применение UML и шаблонов проектирования. М.: Изд. дом «Виль- ямс», 2001. 5. Леоненков А. Самоучитель UML. СПб.: БХВ-Петербург, 2001. 67 ПРИЛОЖЕНИЕ 1. ТИТУЛЬНЫЙ ЛИСТ И ПРИМЕР ТЕХНИЧЕСКОГО ЗАДАНИЯ Министерство образования Российской Федерации МОСКОВСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ ИМ. Н.Э. БАУМАНА Факультет «Информатика и системы управления» Кафедра «Компьютерные системы и сети» УТВЕРЖДАЮ Зав. кафедрой ИУ6, д.т.н., проф. ________Сюзев В.В. “ ___” _______________2002 г. СИСТЕМА УЧЕТА ТЕКУЩЕЙ УСПЕВАЕМОСТИ СТУДЕНТОВ Техническое задание на курсовую работу. Листов 3 Руководитель, к.т.н., доцент ______________ Петров П.П. Исполнитель, студ. гр. ИУ6-21 ____________ Иванов И. И. 2002 68 1. ВВЕДЕНИЕ Во время сессии необходимо получение оперативной информации о ходе ее сдачи студентами, однако выполнение такого контроля вручную требует значительного вре- мени. Автоматизированная система учета успеваемости позволит улучшить качество контроля сдачи сессии со стороны куратора и деканата и обеспечит получение сведе- ний о динамике работы каждого студента, группы в целом и курса. Кроме того, хранение информации о сдаче сессий в течение всего времени обуче- ния позволит осуществлять автоматическую генерацию справок о прослушанных кур- сах и приложений к диплому выпускника. 2. ОСНОВАНИЕ ДЛЯ РАЗРАБОТКИ Основанием разработки является план мероприятий по совершенствованию учеб- ного процесса на 2001-2002 учебный год. 3. НАЗНАЧЕНИЕ Система предназначена для хранения и обработки сведений о успеваемости сту- дентов учебных групп факультета в течение всего срока обучения. Обработанные све- дения об успеваемости студентов могут быть использованы для оценки успеваемости каждого студента, группы, курса и факультета в целом. 4. ТРЕБОВАНИЯ К ПРОГРАММЕ ИЛИ ПРОГРАММНОМУ ИЗДЕЛИЮ 4.1. Требования к функциональным характеристикам Система должна обеспечивать возможность выполнения следующих функций. 4.1.1.Инициализацию системы (ввод списков групп, перечней изучаемых дисцип- лин в соответствии с учебными планами и т.п.). 4.1.2. Ввод и коррекцию текущей информации о ходе сдачи сессии конкретными студентами. 4.1.3. Хранение информации об успеваемости в течение времени обучения студен- та. 4.1.4. Получение сведений о текущем состоянии сдачи сессии студентами в сле- дующих вариантах: − результаты сдачи сессии конкретным студентом; 69 − результаты сдачи сессии студентами конкретной группы; − процент успеваемости по всем студентам группы при сдаче конкретного пред- мета в целом на текущий момент; − проценты успеваемости по всем группам специальности на текущий момент; − проценты успеваемости по всем группам курса на текущий момент; − проценты успеваемости по всем курсам и в целом по факультету на текущий момент; − список задолжников группы на текущий момент; − список задолжников курса на текущий момент; Исходные данные: − списки студентов учебных групп; − учебные планы кафедр – перечень предметов и контрольных мероприятий по каждому предмету; − расписания сессий; − текущие сведения о сдаче сессии каждым студентом. 4.2. Требования к надежности 4.2.1. Предусмотреть контроль вводимой информации. 4.2.2. Предусмотреть блокировку некорректных действий пользователя при работе с системой. 4.2.3. Обеспечить целостность хранимой информации. 4.3. Требования к составу и параметрам технических средств Система должна работать на IBM совместимых персональных компьютерах. Минимальная конфигурация: тип процессора…………………….Pentium и выше; объем ОЗУ ………………………..32 Мб и более 4.4. Требования к информационной и программной совместимости Система должна работать под управлением семейства операционных систем Win 32 (Windows 95, Windows 98, Windows 2000, Windows NT и т.п.). 5. ТРЕБОВАНИЯ К ПРОГРАММНОЙ ДОКУМЕНТАЦИИ 70 5.1. Разрабатываемые программные модули должны быть самодокументированны, т.е. тексты программ должны содержать все необходимые комментарии. 5.2. Программная система должна включать справочную информацию о работе и подсказки пользователю. 5.3. В состав сопровождающей документации должны входить: − пояснительная записка, содержащая описание разработки; − руководство системного программиста; − руководство пользователя. 6. ЭТАПЫ РАЗРАБОТКИ № Название этапа Срок Отчетность 1 2 3 4 1. Анализ требований и уточнение спецификаций 1.10.2002–15.10.2002 Сетевая модель данных. Описание алгоритмов обра- ботки информации. 2. Проектирование: раз- работка структуры ПО, интерфейса пользователя и проектирование ком- понентов. 16.10.2002– 31.10..2002 Схема структурная ПО. Прототип системы на уровне интерфейса. Спецификации компонен- тов систенмы. 3. Реализация: кодиро- вание, тестирование и отладка программных компонентов и системы в целом 1.11.2002–15.12.2002 Программный продукт. 4. Составление про- граммной документации 16.12.2002– 22.12.2002 Пояснительная записка и программная документация. 71 ПРИЛОЖЕНИЕ 2. ТИТУЛЬНЫЙ ЛИСТ РАСЧЕТНО-ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ Министерство образования Российской Федерации МОСКОВСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ ИМ. Н.Э. БАУМАНА Факультет «Информатики и систем управления» Кафедра «Компьютерные системы и сети» СИСТЕМА УЧЕТА ТЕКУЩЕЙ УСПЕВАЕМОСТИ СТУДЕНТОВ Расчетно-пояснительная записка к курсовой работе Листов 25 Руководитель, к.т.н., доцент ______________ Петров П.П. Исполнитель, студ. гр. ИУ6-21 ____________ Иванов И. И. 2002 72 ПРИЛОЖЕНИЕ 3. ПРИМЕРЫ СОДЕРЖАНИЯ РАСЧЕТНО- ПОЯСНИТЕЛЬНЫХ ЗАПИСОК 1. К курсовой работе по «Технологии программирования» (объектный подход): [Реферат (в оглавлении не указывается.) ..................................................... 2] [Оглавление (в оглавлении не указывается) .................................................. 3] Введение ...............................................................................................................4 1. Анализ задания, выбор технологии, языка и среды разработки ................6 2. Определение структуры программного продукта .......................................7 2.1. Анализ процесса обработки информации и выбор структур данных для ее хранения .......................................................................................7 2.2. Выбор методов решения задачи и разработка основных алгоритмов предметной области .........................................................9 2.3. Построение структурной схемы программного продукта ..............11 3. Разработка интерфейса пользователя .........................................................13 3.1. Построение диаграммы переходов состояний интерфейса.............13 3.2. Проектирование форм ввода-вывода информации .........................14 4. Разработка диаграммы (иерархии) классов программы ...........................19 5. Выбор стратегии тестирования и разработка тестов ................................21 Заключение ........................................................................................................24 Список литературы ...........................................................................................25 Приложение 1. Техническое задание на программный продукт (нумерация от- дельная) Приложение 2. Руководство пользователя (нумерация отдельная) 2. К курсовой работе по Технологии программирования (структурный подход): [Реферат (в оглавлении не указывается.) ...................................................... 2] [Оглавление (в оглавлении не указывается) ................................................. 3] Введение ..............................................................................................................4 1. Анализ задания, выбор технологии, языка и среды разработки ................6 2. Определение структуры программного продукта .......................................7 2.1. Анализ процесса обработки информации и выбор структур 73 данных для ее хранения .......................................................................7 2.2. Выбор методов решения задачи и разработка основных алгоритмов предметной области .........................................................9 2.3. Построение структурной схемы программного продукта ..............11 3. Разработка интерфейса пользователя .........................................................13 3.1. Построение графа состояний интерфейса ........................................13 3.2. Разработка форм ввода-вывода информации ..................................14 4. Разработка основных алгоритмов программы ...........................................19 5. Выбор стратегии тестирования и разработка тестов ................................21 Заключение ........................................................................................................24 Список литературы ...........................................................................................25 Приложение 1. Техническое задание на программный продукт (нумерация от- дельная) Приложение 1. Руководство пользователя (нумерация отдельная) 3. К квалификационной работе бакалавра (порядок частей – произвольный): [Краткое задание на квалификационную работу............................................ 2] [Реферат (в оглавлении не указывается.) ...................................................... 3] [Оглавление (в оглавлении не указывается) ................................................. 4] Введение ..............................................................................................................5 I. Выбор архитектуры Internet-приложения ..................................................10 II. Проектирование программной системы ....................................................20 1. Анализ требований и уточнение спецификаций .................................20 2. Разработка структуры программного продукта ..................................26 3. Проектирование классов предметной области ....................................30 4. Проектирование интерфейса пользователя .........................................35 5. Компоновка программных компонентов .............................................38 6. Размещение программных компонентов..............................................41 III. Разработка технологии тестирования разрабатываемого продукта ......44 IV. Маркетинговые исследования ...................................................................54 Заключение ........................................................................................................64 Список литературы ...........................................................................................66 74 Приложение 1. Техническое задание на программный продукт (нумерация от- дельная) Приложение 2. Руководство пользователя (нумерация отдельная) 4. К дипломному проекту (порядок частей – произвольный): [Краткое задание на дипломный проект.......................................................... 2] [Реферат на русском и иностранном языках (в оглавлении не указывается) ..................................................................................... 3] [Оглавление (в оглавлении не указывается) ................................................. 4] Введение ..............................................................................................................5 I. Анализ методов решения задачи ..................................................................12 II. Проектирование программной системы ....................................................24 1. Анализ требований и уточнение спецификаций .................................24 2. Разработка структуры программного продукта ..................................34 3. Проектирование классов предметной области ....................................45 4. Проектирование интерфейса пользователя .........................................53 5. Компоновка программных компонентов .............................................63 III. Разработка технологии тестирования разрабатываемого продукта ......70 IV. Технико-экономическое обоснование разработки...................................79 1. Маркетинговые исследования ..............................................................79 2. Расчет стоимости разработки ...............................................................81 3. Анализ рисков при разработке программного продукта ...................84 V. Организация рабочего места программиста ..............................................88 Заключение ........................................................................................................98 Список литературы .........................................................................................100 Приложение 1. Техническое задание на программный продукт (нумерация от- дельная) Приложение 2. Руководство пользователя |