И УСТАНАВЛИВАЮЩИЕ ИХ ГОСТы

Одним из следствий развития программного обеспечения для ЭВМ явилось значительное расширение круга пользователей. Программисту на сегодняшний день приходится создавать и изучать большое количество документов, описывающих программное обеспечение. Стала очевидной необходимость стандартизации программной документации. В 1980 году введен государственный стандарт - Единая Система Программной Документации - ГОСТ ЕСПД [1].

ГОСТ 19781-74 "Машины вычислительные. Программное обеспечение. Термины и определения" определяет программу как алгоритм, записанный в форме, воспринимаемой вычислительной машиной.

Для широкого использования программы программисту сегодня недостаточно позаботиться лишь о том, чтобы программа выдавала правильные результаты и имела оптимальные характеристики. Необходимым условием является и наличие правильно сформированной и толково написанной документации [2].

Программные документы содержат сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ. Программные документы ориентированы на различных пользователей: разработчиков программ, системных программистов, проблемных программистов, операторов ЭВМ, инженеров по эксплуатации ЭВМ. Многообразие типов программных документов определяет ГОСТ 19.101-77. В соответствии с указанным ГОСТом устанавливаются следующие виды программ:

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

комплекс - программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.

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

Спецификация определяет состав программы и документации на нее. Спецификация является необходимым документом для программ, применяемых самостоятельно, и для комплексов программ. Требования к содержанию и оформлению спецификации устанавливает ГОСТ 19.202 -78.

Текст программы содержит запись программы на исходном языке программирования с необходимыми комментариями. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.401-78.

Описание программы содержит сведения о логической структуре и функционировании программы. Описание логической структуры программы выполняется по приводимой схеме алгоритма программы, соответствующей исходному тексту программы. Описание программы также может содержать дополнительные сведения, соответствующие описанию примененного математического метода. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.402-78.

Программа и методика испытаний содержит требования, подлежащие проверке при испытании программы, а также порядок и методы контроля их соблюдения. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.301-79.

Техническое задание содержит описание назначения и области применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний. В спецификацию техническое задание не вносится. Требования к содержанию и оформлению технического задания устанавливает ГОСТ 19.201-78.

Пояснительная записка содержит укрупненные схемы алгоритмов, общие описания алгоритмов и функционирования программы, а также обоснование принятых технических и технико-экономических решений. Требования к содержанию и оформлению пояснительной записки устанавливает ГОСТ 19.404-79.

Эксплуатационные документы содержат сведения, необходимые для обеспечения правильного функционирования и эксплуатации программы. К основным эксплуатационным документам относятся следующие шесть документов.

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

Руководство системного программиста содержит сведения, необходимые для установки программы в системе, обеспечения ее правильного функциони-рования и настройки программы на условия конкретного применения. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.503-79.

Руководство программиста содержит сведения, необходимые при эксплуатации программы. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.504-79.

Руководство оператора содержит сведения, необходимые для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.505-79.

Описание языка содержит формальное и неформальное описание синтаксиса и семантики языка, созданного разработчиком программы. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.506-79.

Руководство по техническому обслуживанию содержит сведения, необходимые для применения тестовых и диагностических программ при обслуживании технических средств. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.508-79.

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

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

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

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

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

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

К. ГР. ГД – КД

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

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

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

КД - код вида документа, взятый из таблицы 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 – Форма титульного листа программного документа

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

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

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

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

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

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

44. 4346. 04 - 13

Руководитель Студентка гр.4346

доц. каф.44 Бровин Н.Н. Дергачева Е.В.

Нормоконтролер

доц. каф.44 Попов В.П.

Рисунок 2 – Пример заполнения титульного листа программного документа

- 2 -

44. 4846. 00 - 13

СОДЕРЖАНИЕ

1. Описание математических методов получения случайных величин. 2

1.1. Получение псевдослучайных величин................3

1.1.1. Метод середины квадрата...................4

1.1.2. Метод вычетов......................... 7

1.2. Получение дискретных случайных величин........... 12

1.2.1. Получение дискретных случайных величин из заданного

массива с заданным в виде массива законам распреде-

ления............................. 14

1.2.2. Получение дискретных случайных величин из заданного

массива с распределением Пуассона.......... 18

Рисунок 3 – Пример фрагмента содержания программного документа

– 84 –

44.4846.00 -13

Лист регистрации изменений

Номера листов (страниц) Входящ. П Д

Всего Номер номер о а

Изме- Изме- Заме- Новых Аннули- листов доку- сопр. д т

не- нен- ненных рован- (стр.) мента докум. п. а

ние ных ных в и

докум. дата

Рисунок 4 – Форма листа регистрации изменений