Стандарты программной документации

МЕТОДИЧЕСКИЕ РЕКОМЕНДАЦИИ

по выполнению курсовых проектов

по специальности

Программирование в компьютерных системах»

 

РЕКОМЕНДОВАНЫ                                                               рассмоТрено

 научно-методическим советом                                              цикловой комиссией

Протокол № ___                                                                        информационных и

от «___» __________ 2015г.                                                     технических дисциплин

                                                                                              Протокол № _________

Председатель _________                                                          от «___» __________ 2015г.

                                                                                                    Председатель_______Е.С. Спицына

 

 

 

Зам. директора по учебно-производственной работе         ______________Н.Е. Сахарова

 

 

Авторы

 

           _______________ Н.П. Падалкина

 

  _______________В.И. Полусмак

 

_______________Н.Е. Сахарова

Содержание

1 Цели и задачи курсового проекта. 4

2 Тематика курсовых проектов. 4

3 Состав и содержание курсового проекта. 6

4 Требования, предъявляемые к оформлению курсового проекта. 8

5 Стандарты программной документации. 12

ГОСТ Т 9.402-78 ЕСПД. Описание программы.. 12

ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.. 13

Список использованных источников. 14

ПРИЛОЖЕНИЕ А.. 15

Пример оформления введения. 15

ПРИЛОЖЕНИЕ Б. 18

Пример оформления заголовков разделов, подразделов и пунктов. 18

ПРИЛОЖЕНИЕ В.. 19

Примеры оформления рисунков. 19

ПРИЛОЖЕНИЕ Г. 20

Пример оформления таблицы.. 20

ПРИЛОЖЕНИЕ Д.. 21

Пример оформления заключения. 21

ПРИЛОЖЕНИЕ Е.. 22

Пример оформления списка использованных источников. 22

ПРИЛОЖЕНИЕ Ж... 23

1 Цели и задачи курсового проекта

Учебным планом по специальности 09.02.03 «Программирование в компьютерных системах» предусмотрено выполнение курсовых проектов по МДК.01.02 Прикладное программирование (3 курс, 6 семестр) и по МДК.03.01 Технология разработки программного обеспечения (4 курс, 7 семестр).

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

На выполнение курсового проекта планируется 30 аудиторных часов.

Задачами курсового проектирования являются:

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

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

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

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

В результате выполнения курсового проекта обучающийся должен научиться:

- осуществлять формализацию и алгоритмизацию поставленных задач;

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

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

- проводить проверку и отладку программного кода.

Тематика курсовых проектов 

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

Направление и тематика курсовых проектов должны соответствовать компетенциям одного или нескольких профессиональных модулей специальности.

№ п/п	Направление	Соответствие ОПОП (шифр ПМ)
1	Программирование расчётных задач, задач обработки данных (Delphi, С++, др. языки программирования): задачи тестового контроля; задачи моделирования и расчёта производственных процессов	ПМ.01
2	Программирование расчётных задач, задач обработки данных (Delphi, С++, др. языки программирования): задачи тестового контроля; разработка сайтов (HTML, Java script, PHP); задачи моделирования и расчёта производственных процессов	ПМ.03

 

Состав и содержание курсового проекта

Структура курсового проекта

По структуре курсовой проект состоит из теоретической и практической части. 

Пояснительная записка должна включать:

Введение

1. Аналитическую часть:

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

- обзор имеющихся решений проблемы;

- обоснование необходимости разработки (критерии эффективности и качества программы, цели разработки программы).

2. Описание предметной области:

- субъекты объекта управления, проектирования или научного исследования и их отношения;

- объекты управления, проектирования или научного исследования.

2.1. Требования к программному продукту:

- организация входных и выходных данных;

- условия эксплуатации;

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

- требования к информационной и программной совместимости.

3. Программную реализацию проекта:

- выбор технологии программирования;

- выбор среды программирования;

- информационная модель данных;

- описание интерфейса и основных модулей программы;

- инструкция пользователя.

4. Технику безопасности на рабочем месте:

- общие положения.

5. Заключение.

6. Список использованных источников.

7. Приложения.

Требования, предъявляемые к оформлению курсового проекта

На титульном листе должны быть следующие сведения: фамилия и инициалы студента; тема курсового проекта, утвержденная зам. директора по УПР; фамилия, инициалы   научного руководителя (ПРИЛОЖЕНИЕ Ж).

Общие требования

Изложение текста и оформление курсового проекта выполняют в соответствии с требованиями ГОСТ 7.32-2001, ГОСТ 2.105-95, ГОСТ Р 6.30-2003.  

Страницы текста и включенные в работу иллюстрации и таблицы должны соответствовать формату А4 (210x297 мм) по ГОСТ 9327.

Текст курсового проекта следует печатать на одной стороне листа белой бумаги формата А4 через полтора интервала, соблюдая следующие размеры полей: левое поле - 30 мм, правое - 10 мм, верхнее и нижнее - 20 мм. Цвет шрифта должен быть черным, высота букв, цифр и других знаков - не менее 1,8 мм (кегль 14 шрифт Times New Roman).

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

Основной текст следует выравнивать по ширине, используя при этом переносы. Абзацный отступ 1,25 см.

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

1 (первый раздел)

       2.1 (первый подраздел второго раздела)

       2.2.1 (первый пункт второго раздела второго подраздела)

Заголовки структурных элементов курсового проекта (Реферат, Содержание, Обозначения и сокращения, Введение, Заключение, Список использованных источников, Приложение), печатаются с нового листа (страницы) прописными буквами в середине строки без точки и отделяются от текста пропуском одной строки.

Заголовки разделов, подразделов и пунктов следует печатать с абзацного отступа строчными буквами с первой прописной, не подчеркивая, без точки в конце и также отделять от текста пропуском строки. Каждый раздел следует начинать с новой страницы (ПРИЛОЖЕНИЕ А).

Рекомендуется заголовки структурных элементов, разделов, подразделов и пунктов выделять полужирным шрифтом и увеличивать высоту букв на 1-2 пункта.

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

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

Если раздел или подраздел имеет только один пункт или пункт имеет один подпункт, то нумеровать пункт (подпункт) не следует.

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

При необходимости ссылки в тексте на один из элементов перечисления вместо дефиса ставятся строчные буквы в порядке русского алфавита, начиная с буквы а (за исключением букв ё, з, й, о, ч, ь, ы, ъ), после которых ставится скобка. Для обозначения перечислений используют также арабские цифры со скобкой, например:

1)

2)

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

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

Иллюстрации и таблицы, расположенные на отдельных листах, и распечатки с ПЭВМ включают в общую нумерацию страниц отчета. Иллюстрации, таблицы на листе формата A3 учитывают как одну страницу.

Все иллюстрации (фотографии, графики, чертежи, схе­мы, диаграммы и другие графические материалы) именуются в тексте рисунками (ПРИЛОЖЕНИЕ В).

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

Чертежи, графики, диаграммы и схемы должны соот­ветствовать требованиям государственных стандартов ЕСКД.

Иллюстрации при необходимости могут иметь наиме­нование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом:

Рисунок 1 - Название рисунка.

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

Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера рисунка, разделенных точкой. Например, Рисунок 1.1.

 Заголовок таблицы следует выполнять строчными буквами (кроме первой прописной) и помещать над таблицей слева, вровень с её вертикальной линией, без абзацного отступа, в одну строку с её номером через тире (ГОСТ 7.32).

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

Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделённых точкой (ПРИЛОЖЕНИЕ Г).

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

Приложение оформляют как продолжение работы, а если приложений несколько, то каждое следует начинать с новой страницы с указанием наверху посередине страницы слова «ПРИЛОЖЕНИЕ» и его обозначение (ГОСТ 7.32).

Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ, например, «ПРИЛОЖЕНИЕ А». Допускается обозначение приложений буквами латинского алфавита, кроме букв I и O.

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

 

 

Стандарты программной документации