Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
Документирование программного обеспечения.doc
Скачиваний:
64
Добавлен:
02.04.2015
Размер:
200.7 Кб
Скачать

К. Гр. Гд – кд

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

ГР - номер группы, в которой учится студент;

ГД - последние две цифры календарного года, в котором выполняется курсовая работа;

КД - код вида документа, взятый из таблицы 1.

Таблица 1 Шифры документов

Название документа Код вида

документа

Спецификация 01

Текст программы 12

Описание программы 13

Описание применения 31

Руководство системного программиста 32

Руководство программиста 33

Руководство оператора 34

Описание языка 35

Руководство по техническому обслуживанию 46

Программа и методика испытаний 51

Пояснительная записка 81

Титульная часть программного документа состоит из листа утверждения и титульного листа. При выполнении курсовой работы оформляется только титульный лист, а лист утверждения не оформляется. Форма титульного листа программных документов приведена на рисунке 1. Здесь поле 1 содержит наименование министерства и высшего учебного заведения, в котором выполняется курсовая работа. Поле 2 содержит полное наименование программы (прописными буквами), наименование документа. Поле 3 содержит шифр документа. Поле 4 делится на 2 части: в правой части поля 4 приводится фамилия, инициалы и группа студента, подготовившего курсовую работу, в левой части поля 4 указывается должность, фамилия, инициалы руководителя курсового проектирования и должность, фамилия, инициалы нормоконтролера от кафедры. При сдаче курсовой работы студенту рядом с указанием его фамилии необходимо поставить подпись. В поле 5 проставляется год сдачи курсовой работы. На рисунке 2 дан пример заполнения титульного листа.

Информационная часть состоит из аннотации и содержания. Аннотация предшествует содержанию, в ней приводятся общие сведения о назначении документа и краткое изложение основной его части, т.е. общие сведения о программе: назначение, операционная среда, язык программирования, вычислительная система. Содержание является перечнем записей о структурных элементах основной части документа. Содержание состоит из наименований разделов, подразделов и пунктов с указанием соответствующих номеров. В верхнем поле каждой страницы указывается номер страницы документа, ниже - его шифр. Пример фрагмента содержания приведен на рисунке 3.

Основная частьпрограммного документа заполняется в соответствии с ГОСТом на соответствующий вид программного документа. Рекомендации по заполнению основной части некоторых видов программных документов приведены далее в разделе 2. Единым требованием для всех документов является следующее. Каждая страница программного документа имеет вверху два заполненных поля: номер страницы и под ним шифр соответствующего документа, который проставляется на всех листах документа, кроме титульного. Каждый лист документа заполняется только с одной стороны.

Часть регистрации изменений программного документа согласно ГОСТ 19.603-78 представляет собой таблицу, содержащую сведения о всех изменениях программного документа. Лист регистрации изменений должен присутствовать всегда (даже в том случае, если в программе изменений нет). Форма соответствующей таблицы приведена на рисунке 4.

1

2

3

4

5

Рисунок 1 – Форма титульного листа программного документа

Федеральное агентство по образованию

Санкт-Петербургский Государственный Университет

Аэрокосмического Приборостроения

КОМПЛЕКС ПРОГРАММ МОДЕЛИРОВАНИЯ

ДИСКРЕТНЫХ СЛУЧАЙНЫХ ПРОЦЕССОВ

Описание программы