МИНИСТЕРСТВО ОБРАЗОВАНИЯ РОССИЙСКОЙ ФЕДЕРАЦИИ
ВОЛГОГРАДСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ
КУРСОВОЕ ПРОЕКТИРОВАНИЕ
Методические указания по оформлению курсовых проектов (работ),
для студентов специальности 2201 " Вычислительные машины, комплексы, системы и сети"
(разработка программного обеспечения)
Волгоград
1999
УДК 681.31
КУРСОВОЕ ПРОЕКТИРОВАНИЕ. Методические указания по оформлению курсовых проектов (работ) для студентов специальности 2201 "Вычислительные машины, комплексы, системы и сети" (разработка программного обеспечения) /Cост. Деревенсков С.О.; Волгоград.гос.техн.ун-т.- Волгоград, 1999. – 24 с.
Содержатся общие требования и рекомендации по оформлению курсовых проектов (работ), связанных с разработкой программного обеспечения, для студентов специальности 2201 "Вычислительные машины, комплексы, системы и сети". Приведено краткое изложение основных стандартов Единой системы программной документации (ЕСПД).
Предназначены для студентов, обучающихся по направлению 5528 "Информатика и вычислительная техника" и специальности 2201 "Вычислительные машины, комплексы, системы и сети" всех форм обучения.
Ил. 3
Рецензент Муха Ю.П.
Печатается по решению редакционно-издательского совета Волгоградского государственного технического университета
 Волгоградский
государственный
технический
университет, 1999
- 3 -
ОСНОВНЫЕ СВЕДЕНИЯ
Целью курсового проектирования является закрепление и углубление теоретических знаний и приобретение практических навыков по изучаемой дисциплине при разработке программного обеспечения.
В задачи курсового проектирования входят:
изучение особенностей конкретной предметной области, относящихся к теме курсового проекта (работы);
анализ возможных подходов и методов решения с обоснованием выбранного подхода;
выбор или разработка модели (математической, структурной, информационной и т.д.), необходимой для достижения цели;
выбор эффективных алгоритмов с учетом их точности, устойчивос-ти, сходимости и прочих параметров;
разработка программного обеспечения, программной и эксплуатацион-ной документации;
анализ полученных результатов работы программного обеспечения.
Курсовой проект (работа) должен включать оттестированное программное обеспечение и пояснительную записку. В зависимости от дисциплины в курсовой проект (работу) может быть включена графическая часть.
Пояснительная записка проекта (работы) должна иметь следующую структуру:
титульный лист курсового проекта (работы) установленного образца (приложение 1);
задание к курсовому проекту (работе) установленного образца (приложение 2);
аннотация (краткое содержание работы);
cодержание;
введение;
теоретическая часть;
программная документация;
эксплуатационная документация;
заключение;
литература;
приложения.
Во введении кратко описывается состояние предметной области, формулируются цель и задачи проекта (работы).
В теоретической части проводится сравнительный анализ возможных вариантов решения поставленной задачи, приводится обоснование и краткое описание выбранного варианта.
Программная документация может включать следующий комплекс документов:
- 4 -
техническое задание (ГОСТ 19.201-78), определяющее требования, предъявляемые к программному обеспечению, необходимые стадии и сроки разработки, виды испытаний;
описание программы (ГОСТ 19.402-78), в котором содержатся сведения о логической структуре и функционировании программного обеспече-ния;
текст программы (ГОСТ 19.401-78), в котором содержится запись исходного текста программы с необходимыми коментариями;
программа и методика испытаний (ГОСТ 19.301-79), содержащая требования, подлежащие проверке при испытании программного обеспечения, а также порядок и методы контроля.
Эксплуатационная документация может включать следующий комплекс документов:
руководство системного программиста (ГОСТ 19.503-79), включающее сведения, необходимые для инсталляции, проверки, обеспечения функционирования и настройки программного обеспечения;
руководство программиста (ГОСТ 19.504-79), содержащее сведения, необходимые для эксплуатации программного обеспечения;
руководство оператора (ГОСТ 19.505-79), содержащее сведения, необходимые для обеспечения интерфейса пользователя в процессе работы программного обеспечения.
Заключение включает основные выводы и перспективы дальнейшего развития программного обеспечения, разработанного в ходе выполнения курсового проекта (работы).
Графическая часть курсового проекта (работы) выполняется в виде плакатов, на которых могут быть представлены следующие результаты:
функциональная структура программного обеспечения, показывающая функциональное назначение всей программы и ее отдельных частей;
модульная (иерархическая) структура программного обеспечения, фиксирующая результаты структурного проектирования программного обеспечения;
диаграммы наследования, зависимостей, классов, фиксирующие результаты объектно-ориентированного проектирования программ-ного обеспечения;
схемы программ (ГОСТ 19.701-90), отображающие последовательность выполняемых операций;
схемы данных (ГОСТ 19.701-90), отображающие путь данных при решении задач и определяющие этапы их обработки;
схемы взаимодействия программ (ГОСТ 19.701-90), отображающие путь активизаций программ и взаимодействий с соответствующими данными;
схему работы системы (ГОСТ 19.701-90), отображающую управление операциями и поток данных в системе;
- 5 -
результаты работы программного обеспечения, показывающие наибо-лее типичные результаты в форме графиков, таблиц, примеров выходной документации и т.п.
В верхней части каждого плаката должно быть указано его название. Для схем алгоритмов, программ, данных и систем, предусмотренных ГОСТ 19.701-90, название должно состоять из наименования программы (программного модуля) и вида схемы, например, “Загрузчик. Схема алгоритма”. В нижнем поле каждый плакат должен содержать подписи исполнителя и руководителя проекта (работы) с расшифровкой.
Состав программной и эксплуатационной документации, а также объем и содержание графической части определяются руководителем курсового проекта (работы) исходя из объема часов, предусмотренных учебным планом на выполнение курсового проекта (работы) с учетом специфики конкретной дисциплины. Согласно п. 2.6 ГОСТ 19.101-77 допускается объединять отдельные виды эксплуатационных документов. Объединенному документу присваивается наименование и обозначение одного из объединяемых документов. Необходимость объединения документов должна быть указана в техническом задании. Рекомендуемый минимальный объем документации включает Техническое задание, Описание программы и Текст программы.
ОФОРМЛЕНИЕ ПРОГРАММНОЙ И ЭКСПЛУАТАЦИОННОЙ ДОКУМЕНТАЦИИ
Обозначение программ и программных документов
(ГОСТ 19.303-79).
1. Настоящий стандарт устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
2. Обозначение программ и документов должно состоять из групп знаков, разделенных точками (после кода страны и кода организации-разработчика), пробелами (после номера редакции документа и кода вида документа), дефисами (после регистрационного номера и номера документа данного вида).
3. Устанавливается регистрационная система обозначения программ и
программных документов.
Структура обозначения программных документов:
- 6 -
       A.B.XXXXX-XX XX XX-X
Код страны
  Код организации - разработчика
 Регистрационный номер
Номер редакции
 Код вида документа
  Номер документа данного вида
 Номер части документа
5. Код страны разработчика и код организации (предприятия)-разработчика присваивают в установленном порядке.
Регистрационный номер присваивают в соответствии с Общесоюзным
классификатором программ, утверждаемым Госстандартом, в установленном порядке.
До утверждения Общесоюзного классификатора программ допускается
присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.
Номер издания программы или номер редакции документа присваи-вают в порядке возрастания с 01 до 99.
6. Код вида документа присваивают в соответствии с требованиями
ГОСТ 19.101-77:
12 – Текст программы;
13 – Описание программы;
32 – Руководство системного программиста;
33 – Руководство программиста;
34 – Руководство оператора;
51 – Программа и методика испытаний;
81 – Пояснительная записка;
90 – 99 - Прочие документы (в том числе Техническое задание).
7. Номер документа данного вида присваивают в порядке возрастания с 01 до 99.
8. Номер части одного и того же документа присваивают в порядке возрас-тания с 1 до 9. Если документ состоит из одной части, то дефис и порядковый номер части не указывают.
Согласно стандарту ВолгГТУ СТП ВГТУ 022-93 для студенческих курсовых проектов и работ вместо кода страны в обозначении документа указывается индекс проекта (работы) - литеры КР (для курсовой работы) или КП (для курсового проекта), а затем две цифры, обозначающие год разработки. В качестве кода организации-разработчика указывается 40461806 (код ВолгГТУ). Две первые цифры регистрационного номера должны быть 19 (шифр кафедры ЭВМ и систем), а три последние цифры должны соответствовать трем последним цифрам номера зачетной книжки студента.
- 7 -
Например, документ “Описание программы”, выполненный в 1999 г. в курсовой работе студента, имеющего зачетную книжку N 971425 будет иметь обозначение КР99.40461806.19425- 01 13 01 .
Основные надписи (ГОСТ 19.104 – 78).
Настоящий стандарт устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами Единой системы программной документации (ЕСПД), независимо от способа их выполнения.
1. ОСНОВНЫЕ ПОЛОЖЕНИЯ
1.1. В состав основных надписей листа утверждения и титульного листа в программных документах входят следующие структурные данные:
наименование министерства (ведомства);
наименование документа;
обозначение документа;
сведения о носителе данных, на котором представляется подлинник;
общее количество листов утверждения, объем документа;
сведения о разработчике;
подпись нормоконтролера;
отметка об учете и хранении;
сведения об изменении.
2. ОСНОВНЫЕ НАДПИСИ ЛИСТА УТВЕРЖДЕНИЯ (ЛУ)
2.1. Лист утверждения выпускается на каждый программный документ на листах бумаги формата А4 (ГОСТ 2.301-68) независимо от вида документа, кото-рый может быть выполнен на любом носителе данных.
2.2. Обозначение листа утверждения состоит из обозначения доку-мента, к которому относится лист утверждения, и через дефис - шифра ЛУ.
Лист утверждения не входит в общее количество листов документа.
2.3. Лист утверждения может включать несколько листов, в этом случае каждый лист нумеруется. На первом листе указывается общее количество листов, входящих в лист утверждения.
Второй и последующие листы утверждения оформляют в соответствии с разд.1 ГОСТ 19.106-78, при этом в поле "текст документа" приводят должности и подписи лиц, не уместившихся на первом листе листа утверждения.
2.4. Лист утверждения вносят в спецификацию после утверждения доку-мента и хранят на предприятии - держателе подлинника документа.
Лист утверждения спецификации также вносят в данную спецификацию.
Копии листа утверждения высылают заказчику и головному предприятию.
По особому разрешению заказчика лист утверждения может быть выслан и в другие организации.
2.5. Лист утверждения заполняют по форме, приведенной на рис.1:
поле 1 - наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ.
- 8 -
Заполняют по требованию заказчика.
Выше поля 1, в правом верхнем углу, при необходимости, ставят специальную отметку (гриф секретности, указание "С предприятия не выносить" и т.п.);
поле 2 - в левой части поля - должности и подписи лиц, согласовавших документ от организации заказчика при необходимости, в правой части поля - должность и подпись лица, утвердившего документ от организации разработчика.
Справа от каждой подписи проставляют инициалы и фамилию лица, подписавшего документ, а ниже подписи - дату подписания.
Согласующие и утверждающие организации, а также конкретные подписи должностных лиц регламентируют министерства и ведомства.
поле 3 - полное наименование программы или программного изделия (прописными буквами), наименование и вид документа.
Наименование документа может быть опущено или объединено с наименованием программы;
поле 4 - обозначение документа и указание вида носителя данных.
Вид носителя данных указывают только в случае выполнения прог-раммного документа на носителе данных;
поле 5 - общее количество листов утверждения, например, "Листов 3".
Для одного листа поле 5 не заполняют;
поле 6 - в правой части поля - должности и подписи руководителя организации, выпустившей документ, руководителя подразделения, разработав-шего документ, руководителя разработки (разработчика), исполнителей разработки документа и нормоконтролера.
Справа от каждой подписи проставляют инициалы и фамилию лица, подписавшего документ, а ниже подписи - дату подписания.
При большом количестве согласующих подписей их размещают либо в
левой части поля 2, либо в левой части поля 6.
Визы других должностных лиц, если они необходимы на документе, раз-мещают на поле для подшивки ЛУ;
поле 7 - год издания (утверждения) документа (без указания слова "год" или "г");
поле 8 - отметка об учете и хранении по ГОСТ 19.601-78;
поле 9 - строка изменений по ГОСТ 19.604-78;
поле 10 - литера документа.
3. ОСНОВНЫЕ НАДПИСИ ТИТУЛЬНОГО ЛИСТА
3.1. Титульный лист заполняют по форме и правилам, установленным для ЛУ, при этом:
поле 1 - заполняют по требованию заказчика;
поле 2 - не заполняют;
поле 3 - полное наименование программы или программного изделия (прописными буквами), наименование и вид документа.
- 9 -
Наименование документа может быть опущено или объединено с наименованием программы. Допускается указывать сокращенное наименование программы или программного изделия;
поле 4 - обозначение документа и указание вида носителя данных.
Вид носителя данных указывают только в случае выполнения программного документа на носителе данных;
поле 5 - указывают объем документа;
поле 6 - не заполняют;
поле 7 - год издания (утверждения) документа (без указания слова "год" или "г");
поле 8 - отметка об учете и хранении по ГОСТ 19.601-78;
поле 9 - строка изменений по ГОСТ 19.604-78;
поле 10 - литера документа.
3.2. На титульном листе в левом верхнем углу должна быть надпись:
Утвержден
обозначение ЛУ
4. ОСНОВНЫЕ НАДПИСИ В ТЕКСТЕ ДОКУМЕНТА
4.1. Содержание и правила выполнения основных надписей в программных документах на конкрктных носителях данных приведены в со-ответствующих государственных стандартах ЕСПД.
4.2. Содержание и правила выполнения основных надписей последующих листов программных документов, выполненных печатным способом, приведены в ГОСТ 19.106-78.
На рис.1 приведена форма листа утверждения, на рис. 2 – пример заполнения листа утверждения, а на рис. 3 – пример заполнения титульного листа.
Поля 8, 9 и 10 листа утверждения и титульного листа в студенческих курсовых проектах и работах допускается не заполнять.
- 10 -
|
