close

Вход

Забыли?

вход по аккаунту

?

Barikov 064127E175

код для вставкиСкачать
МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ
Федеральное государственное автономное образовательное учреждение
высшего профессионального образования
САНКТ-ПЕТЕРБУРГСКИЙ ГОСУДАРСТВЕННЫЙ УНИВЕРСИТЕТ
АЭРОКОСМИЧЕСКОГО ПРИБОРОСТРОЕНИЯ
ДОКУМЕНТИРОВАНИЕ
ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
Методические указания
к выполнению курсовой работы
Санкт-Петербург
2013
Составитель  Л. Н. Бариков
Рецензент
кандидат технических наук В. А. Галанина
Содержатся материалы, необходимые для оформления программной
документации, входящей в состав пояснительной записки к курсовому проекту, предусмотренному учебным планом по дисциплине «Программиро­
вание. Программирование на языках высокого уровня».
Предназначено для студентов очной, очно-заочной (вечерней) и заочной
форм обучения по направлению 230100.62 «Информатика и вычислительная техника» (профиль – Вычислительные машины, комплексы, системы
и сети).
Подготовлены к публикации кафедрой Вычислительных систем и сетей
по рекомендации методической комиссии факультета Вычислительных
­систем и программирования Санкт-Петербургского государственного университета аэрокосмического приборостроения.
В авторской редакции
Верстальщик И. Н. Мороз
Сдано в набор 06.09.13. Подписано к печати 10.09.13.
Формат 60×841/16. Бумага офсетная. Усл. печ. л. 2,09.
Уч.-изд. л. 2,25. Тираж 100 экз. Заказ № 419.
Редакционно-издательский центр ГУАП
190000, Санкт-Петербург, Б. Морская ул., 67
© Санкт-Петербургский государственный
университет аэрокосмического
приборостроения (ГУАП), 2013
ВВЕДЕНИЕ
Курсовое проектирование является завершающим и одним из важнейших этапов подготовки специалистов по дисциплине «Программирование. Программирование на языках высокого уровня». Одной из основных
целей этого этапа является обучение студентов оформлению необходимой
программной документации на разработанное программное средство в соответствии с требованиями ЕСПД.
Предлагаемое пособие содержит информационный материал, необходимый студентам очной, очно-заочной (вечерней) и заочной форм
обучения по направлению 230100.62 «Информатика и вычислительная
техника» (профиль – Вычислительные машины, комплексы, системы и сети), при выполнении курсового проекта, предусмотренного учебным планом по дисциплине «Программирование. Программирование на языках
высокого уровня». Предлагаемый информационный материал обеспечивает выполнение всех требований по оформлению программных документов,
которые определены ГОСТами ЕСПД к набору программных документов
при сдаче программного продукта в Государственный Фонд Алгоритмов
и Программ.
3
1. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
И УСТАНАВЛИВАЮЩИЕ ИХ ГОСТЫ
Стандартизация программной документации реализуется в нашей
стране с 1980 года, когда был введен новый государственный стандарт –
Единая Система Программной Документации – ГОСТ ЕСПД [1].
С этого момента любой программный продукт, предназначенный
для широкого (в том числе, и коммерческого) использования, должен сопровождаться
определенным
набором
программной
документации.
В зависимости от назначения и сложности программного продукта состав
этого набора может меняться. Но в любом случае каждый документ, входящий в этот набор, должен строго соответствовать ГОСТу на этот документ.
ГОСТ 19781-74 «Машины вычислительные. Программное обеспечение. Термины и определения» определяет программу как алгоритм, записанный в форме, воспринимаемой вычислительной машиной. Многообразие
типов
программных
документов
определяет
ГОСТ 19.101-77.
В соответствии с ним устанавливаются следующие виды программ:
компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или
в составе программного комплекса;
комплекс – программа, состоящая из двух или более компонентов
и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
В соответствии с установленными требованиями при выполнении
курсового проекта на программный продукт оформляется часть перечисленной ниже документации.
Документ Спецификация определяет состав программной документации на разработанный программный продукт. Спецификация является
необходимым документом для программ, применяемых самостоятельно,
и для комплексов программ. Требования к содержанию и оформлению
Спецификации устанавливает ГОСТ 19.202-78.
4
Документ Текст программы содержит запись программы на исходном
языке программирования с необходимыми комментариями. Требования
к содержанию и оформлению документа устанавливает ГОСТ 19.401-78.
Документ Описание программы содержит сведения о логической
структуре и функционировании программы. Описание логической структуры программы выполняется по приводимой схеме алгоритма программы,
соответствующей исходному тексту программы. Описание программы
также может содержать дополнительные сведения, соответствующие описанию примененного математического метода. Требования к содержанию
и оформлению документа устанавливает ГОСТ 19.402-78.
Документ Программа и методика испытаний содержит требования,
подлежащие проверке при испытании программы, а также порядок
и методы контроля их соблюдения. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.301-79.
Документ Техническое задание содержит описание назначения
и области применения программы, технические, технико-экономические
и специальные требования, предъявляемые к программе, необходимые
стадии и сроки разработки, виды испытаний. В документ Спецификация
техническое задание не вносится. Требования к содержанию и оформлению технического задания устанавливает ГОСТ 19.201-78.
Документ Пояснительная записка содержит укрупненные схемы алгоритмов, общие описания алгоритмов и функционирования программы,
а также обоснование принятых технических и технико-экономических решений. Требования к содержанию и оформлению Пояснительной записки
устанавливает ГОСТ 19.404-79.
Среди программных документов могут быть выделены т. н. эксплуатационные документы. Эти документы содержат сведения, необходимые
для обеспечения правильного функционирования и эксплуатации программы. К основным эксплуатационным документам относятся следующие шесть документов.
5
Документ Описание применения содержит сведения о назначении
программы, области применения, применяемых методах, класса решаемых
задач, ограничениях для применения, минимальной конфигурации технических средств, операционной среде. Требования к содержанию и оформлению данного документа устанавливает ГОСТ 19.502-78.
Документ Руководство системного программиста содержит сведения, необходимые для установки программы в системе, обеспечения ее
правильного функционирования и настройки программы на условия конкретного применения. Требования к содержанию и оформлению документа
устанавливает ГОСТ 19.503-79.
Документ Руководство программиста содержит сведения, необходимые при эксплуатации программы. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.504-79.
Документ Руководство оператора содержит сведения, необходимые
для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы. Требования к содержанию
и оформлению документа устанавливает ГОСТ 19.505-79.
Документ Описание языка содержит формальное и неформальное
описание синтаксиса и семантики языка, созданного разработчиком программы. Требования к содержанию и оформлению документа устанавливает ГОСТ 19.506-79.
Документ Руководство по техническому обслуживанию содержит
сведения, необходимые для применения тестовых и диагностических программ при обслуживании технических средств. Требования к содержанию
и оформлению документа устанавливает ГОСТ 19.508-79.
Поскольку в состав набора программной документации на конкретное
программное средство могут входить различные документы из приведенного перечня, которые предназначены для разных целей и разных типов
пользователей этого программного средства, то информация о программном средстве может дублироваться в нескольких программных документах, но с разной степенью подробности и под разным углом зрения.
6
Общие данные, такие как обозначение программы, наименование,
назначение и область применения указываются без изменения во всех программных документах.
Информация о входных и выходных данных дается в нескольких документах, но с разной степенью подробности. Например, в документе
Описание программы следует подробно указать характер и организацию
данных, предварительную подготовку и формат данных, подробно описать
применяемые в программе структуры данных и размещение в них входной
и выходной информации, дать способ кодирования информации, если он
существует. В документе Руководство программиста должна быть подробно описана общая структура данных, включая и промежуточные данные. В документе Описание применения требуется указать лишь общие
сведения о входных и выходных данных.
Часть информации в различных документах дается в разных аспектах.
Например, когда речь идет о вызове и загрузке в описании программы, то
следует указать способ вызова программы с носителя данных. В руководстве программиста следует описать процедуру вызова программы (способы передачи управления и параметров вызова). В руководстве оператора
следует описать последовательность действий оператора, обеспечивающих
загрузку и запуск программы.
При оформлении пояснительной записки к курсовой работе обязательными документами, входящими в ее состав, являются документы
Спецификация, Текст программы, Описание программы, Описание
применения. Руководитель курсового проектирования может в каждом
конкретном случае потребовать дополнительного оформления еще ряда
документов.
Каждому программному документу присваивается обозначение, которое является уникальным и называется в дальнейшем шифром документа.
7
Структуру этого обозначения определяет ГОСТ 19.103-77. При курсовом
проектировании примем следующую форму обозначения:
К. ГР. ГД – КД
где К – номер кафедры, на которой проводится курсовое проектирование;
ГР – номер группы, в которой учится студент;
ГД – последние две цифры календарного года, в котором выполняется
курсовой проект;
КД – код вида документа, взятый из табл. 1.
Таблица 1
Коды вида документа
Название документа
Код вида
документа
Спецификация
01
Текст программы
12
Описание программы
13
Описание применения
31
Руководство системного программиста
32
Руководство программиста
33
Руководство оператора
34
Описание языка
35
Руководство по техническому обслуживанию
46
Программа и методика испытаний
51
Пояснительная записка
81
Согласно ГОСТ 19.106-78 каждый программный документ должен
состоять из следующих частей:
– титульной,
– информационной,
– основной,
– регистрации изменений.
Титульная часть программного документа состоит из листа утверждения и титульного листа. При выполнении курсовой работы оформляется только титульный лист, а лист утверждения не оформляется. Форма титульного листа программных документов приведена на рис. 1. Здесь поле 1
8
содержит наименование министерства и высшего учебного заведения,
в котором выполняется курсовой проект. Поле 2 содержит полное наименование программы (прописными буквами), наименование документа. Поле 3 содержит шифр документа. Поле 4 делится на 2 части: в правой части
поля 4 приводится фамилия, инициалы и группа студента, подготовившего
курсовой проект, в левой части поля 4 указывается должность, фамилия,
инициалы руководителя курсового проектирования и должность, фамилия,
инициалы преподавателя, ответственного за нормоконтроль на кафедре.
При сдаче курсового проекта студенту рядом с указанием своей фамилии
необходимо поставить подпись. В поле 5 проставляется год сдачи курсового проекта. На рис. 2 дан пример заполнения титульного листа.
1
2
3
4
4
5
Рис. 1. Форма титульного листа программного документа
9
Информационная часть состоит из аннотации и содержания. Аннотация предшествует содержанию, в ней приводятся общие сведения
о назначении документа и краткое изложение основной его части, т. е. общие сведения о программе: назначение, операционная среда, язык программирования, вычислительная система. Содержание является перечнем
записей о структурных элементах основной части документа. Содержание
состоит из наименований разделов, подразделов и пунктов с указанием
соответствующих номеров этих пунктов и номеров страниц, на которых
они начинаются. Пример фрагмента содержания приведен на рис. 3.
МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ
Федеральное государственное автономное образовательное учреждение
высшего профессионального образования
«Санкт-Петербургский государственный университет
аэрокосмического приборостроения»
КОМПЛЕКС ПРОГРАММ МОДЕЛИРОВАНИЯ
ДИСКРЕТНЫХ СЛУЧАЙНЫХ ПРОЦЕССОВ
Описание программы
44. 4241. 14 - 13
Руководитель
доц. Бариков Л. Н.
Студентка гр. 4241
Федяева Е. В.
Нормоконтролер
доц. Попов В. П.
2014
Рис. 2. Пример заполнения титульного листа программного документа
10
3
44.4241.14 - 13
СОДЕРЖАНИЕ
1. Общие сведения
4
2. Функциональное назначение
5
3. Описание логической структуры
6
4. Схема алгоритма программы
7
5. Спецификация подпрограмм
12
6. Используемые технические средства
15
7. Вызов и загрузка
16
8. Входные данные
17
9. Выходные данные
18
Лист регистрации изменений
19
Рис. 3. Пример фрагмента содержания программного документа
Основная часть программного документа заполняется в соответствии
с ГОСТ на соответствующий вид программного документа. Рекомендации
по заполнению основной части некоторых видов программных документов
приведены далее в разделе 2. Единым требованием для всех документов
является следующее. Каждая страница программного документа, за исключением титульного листа, имеет вверху два заполненных поля: номер
страницы в правом верхнем углу и шифр соответствующего документа
по центру страницы. Каждая страница документа заполняется только
с одной стороны.
Часть регистрации изменений программного документа согласно
ГОСТ 19.603-78 представляет собой таблицу, содержащую сведения обо
всех изменениях программного документа. Лист регистрации изменений
должен присутствовать всегда (даже в том случае, если в программном
11
документе изменений не было). Форма соответствующей таблицы приведена на рис. 4.
19
44.4241.14 - 13
Лист регистрации изменений
Входящий
Всего
№ сопроволистов
№
Изм. изменен- замененаннули- (страниц) докум. дительного
новых
докум.
ных
ных
рованных в докум.
и дата
Рис. 4. Форма листа регистрации изменений
12
Дата
Подп.
Номера листов (страниц)
2. СОДЕРЖАНИЕ ОСНОВНОЙ ЧАСТИ
ПРОГРАММНЫХ ДОКУМЕНТОВ
Материалы любого программного документа располагаются в следующей последовательности:
– титульный лист (первый лист документа, страница не нумеруется),
– лист аннотации (второй лист документа),
– лист (листы) содержания,
– текст документа,
– приложения,
– лист регистрации изменений (последний лист документа).
Приложения выполняются при необходимости и служат для лучшего
понимания принципа работы программы. Приложения могут содержать
примеры использования программы, примеры расположения исходных
данных в программных структурах и другие сведения, облегчающие понимание программы.
Аннотация располагается на отдельной пронумерованной странице
документа с заголовком «АННОТАЦИЯ» (раздел документа без номера).
Содержание документа располагается на отдельной пронумерованной странице (страницах) сразу после аннотации, снабжается заголовком
«СОДЕРЖАНИЕ".
2.1. Требования к содержанию документа Текст программы
ГОСТ 19.101-77 определяет программный документ «Текст программы» как запись программы с необходимыми комментариями. Этот документ должен состоять из титульной части, информационной части,
основной части, части регистрации изменений.
В разделе «СОДЕРЖАНИЕ» информационной части документа
должны быть указаны названия всех программных единиц (программ,
подпрограмм, модулей, и т. д.), входящих в программный комплекс
13
и номера страниц документа, на которых располагаются тексты соответствующих программных единиц.
В основной части документа должны быть представлены тексты всех
программных единиц, причем текст каждой программной единицы должен
начинаться со спецификации и снабжаться необходимыми комментариями.
Спецификацией назовем краткое определение функционального назначения программного продукта и описание входных и выходных данных,
а также ряда внутренних структур данных, необходимых для понимания
логики работы программы. Спецификация должна предварять общий текст
программы и располагаться в отдельных строках комментария. Основной
текст программы должен быть снабжен комментариями, определяющими
логику работы программы. Комментарии должны быть такими, чтобы,
прочитав их без текста программы, можно было восстановить логику работы программы. Лучшей документацией внутренней логики программы является простая и ясная структура текста программы, использование сдвига
по строке в соответствии с уровнем вложенности, осмысленные имена
и соблюдение других правил, касающихся хорошего стиля программирования [3, 4, 5, 6]. Пример текста программы приведен на рис. 5.
Продуманный и обоснованный выбор структур данных, наиболее
адекватно отражающих моделируемую предметную область, а также соответствующее описание их в тексте программы могут повлиять на эффективность и легкость чтения текста программы. В программах для обеспечения большей универсальности и более легкой модифицируемости рекомендуется избегать явных констант, кроме таких общеупотребительных
констант как нуль и единица.
Структура программы должна быть простой и легко воспринимаемой
при первом чтении. Следует разбивать программу на отдельные подпрограммы, выделяя повторяющиеся части программы. Умелое разбиение
программного продукта на подпрограммы, текст которых не превышает
размера одной страницы программного текста, позволит сделать программу легко читаемой, облегчит и ускорит ее отладку.
14
Program Control;
{Программа контроля правильности расстановки всех видов скобок
в программах} Uses Stack; {Подключение модуля для работы со стеком}
Procedure Brackets(NameF:String); {Процедура проверки правильности
расстановки скобок в тексте программы – текстовом файле с именем
NameF }
Procedure Error(n:Byte; s:Char); {Процедура расшифровки ошибок}
Begin Case n Of
1 : WriteLn(‘Нет соответствия ’,s,’ скобок !’);
2 : WriteLn(‘Лишняя закрывающая скобка ’,s,’ !’);
3 : WriteLn(‘Лишняя открывающая скобка ’,s,’ !’);
End;
End; {Error}
Var FT:Text; Top:TP; s,sz,sk:Char;
Begin
Assign(FT,NameF);
Reset(FT);
InitStack(Top); {Инициализация стека}
While Not Eof(FT) {Пока не достигнут конец файла}
Do Begin While Not EoLn(FT) {Пока не достигнут конец строки}
Do Begin Read(FT,s);
Case s of
‘(‘,’[‘,’{‘: InStack(s,Top);
‘}’,’]’,’)’: If Not EmptyStack(Top)
Then Begin {Стек не пуст}
OutStack(sk,Top);
Case sk of
‘(‘ : sz:=’)’;
‘[‘ : sz:=’]’;
‘{‘ : sz:=’}’
End;
If s<>sz
Then Begin Error(1,s); Exit;
End;
End
Else Begin {Стек пуст} Error(2,s); Exit;
End;
End; {Case}
End; {While}
ReadLn(FT);
End;
Close(FT);
If EmptyStack(Top) {Если стек пуст}
Then WriteLn(‘Скобки расставлены правильно!’)
Else Begin OutStack(sk,Top); Error(3,sk);
End;
End; {Brackets}
Рис. 5. Текст программы Control
15
Function FileExist(NameF:String):Boolean;
{Функция проверки существования файла любого вида}
Var F:File; {Любой вид файла}
Begin Assign(F,NameF);
{$I-} {Отключение автоматического контроля чтения-записи}
Reset(F); {Открытие файла для чтения}
{$I+} {Включение автоматического контроля чтения-записи}
If IOResult=0 {Если файл существует}
Then Begin FileExist:=True;
Close(F);
End
Else FileExist:=False;
End; {FileExist}
Var NameFT:String; s:Char;
Begin
Repeat
WriteLn(‘Введите полное имя файла с текстом проверяемой программы’);
ReadLn(NameFT);
If FileExist(NameFT) Then Brackets(NameFT)
Else WriteLn(‘Файл’,NameFT,’не существует!’);
WriteLn(‘Проверить еще одну программу ?’);
ReadLn(s);
Until Not (s in [‘Д’,’д’,’Y’,’y’]);
End.
UNIT Stack; {Модуль для работы со стеком}
INTERFACE {Интерфейсная часть модуля}
Type TInf=Char; {Тип информации}
TP=^TEl; {Ссылочный тип}
TEl=Record
inf:TInf; {Поле информации}
pSled:TP; {Поле ссылки}
End;
Procedure InitStack(Var Top:TP);
{Инициализация стека}
Function EmptyStack(Top:TP):Boolean;
{Проверка пустоты стека}
Procedure InStack(X:TInf;Var Top:TP);
{Включение элемента}
Procedure OutStack(Var X;TInf;Var Top:TP); {Извлечение элемента}
IMPLEMENTATION {Исполняемая часть модуля}
Procedure InitStack(Var Top:TP); {Процедура инициализации стека}
Begin
Top:=Nil; {Ссылка на вершину стека}
End; {InitStack}
Function EmptyStack(Top:TP):Boolean; {Функция проверки пустоты стека}
Begin
EmptyStack:=Top=Nil;
End; {EmptyStack}
Рис. 5 (продолжение)
16
Procedure InStack(X:TInf; Var Top:TP); {Процедура включения элемента в стек}
Var pn:TP; {Ссылка на новый элемент}
Begin
New(pn);
{Резервирование памяти для нового элемента}
pn^.inf:=X;
{Заполнение поля информации}
pn^.pSled:=Top; {Заполнение поля ссылки}
Top:=pn;
{Новая ссылка на вершину стека}
End; { InStack }
Procedure OutStack(Var X:TInf;Var Top:TP); {Процедура извлечения элемента из стека}
Var pu:TP; {Ссылка на удаляемый элемент}
Begin
If Top<>Nil {Если стек не пуст}
Then Begin
X:=Top^.inf; {Извлечение информации}
pu:=Top;
{Запоминание ссылки на удаляемый
элемент}
Top:=Top^.pSled; {Новая ссылка на вершину стека}
Dispose(pu); {Освобождение памяти}
End;
End; {OutStack}
End.
Рис. 5 (продолжение)
Необходимо выполнять исчерпывающие проверки в программе. Анализ корректности входных данных в программе является обязательным.
Не следует писать изменяющих себя программ. Несомненную пользу программисту принесет знакомство с литературой, посвященной технике
и технологии программирования [3–6].
2.2. Требования к содержанию документа Описание программы
ГОСТ 19.101-77 определяет программный документ «Описание программы» как совокупность сведений о логической структуре и функционировании программы. Программный документ «Описание программы»
должен состоять из четырех основных частей: титульной части, информационной части, основной части, части регистрации изменений.
17
Основная часть документа должна содержать следующие разделы:
общие сведения, функциональное назначение, описание логической структуры, используемые технические средства, вызов и загрузка, входные
данные, выходные данные.
В зависимости от особенностей программы допускается вводить новые разделы или объединять отдельные разделы. При описании программного продукта, содержащего несколько программных единиц (программ,
подпрограмм), описание по указанной схеме дают для каждой программной единицы, придерживаясь при этом иерархии компоновки общего программного продукта. Так, например, если общая программа Control включает обращение к функции FileExist и процедуре Brackets, которая в свою
очередь обращается к процедуре Error, (общая схема иерархии данного
программного продукта изображена на рис. 6 в виде структурной диаграммы), то описание необходимо начинать с программной единицы Control.
Далее необходимо описывать программные единицы FileExist, Brackets,
Stack, затем описать программную единицу Error в составе Brackets.
Control
Программа проверки
расстановки скобок
в текстах программ
Brackets
Процедура проверки
правильности расстановки скобок
Error
Процедура
расшифровки скобок
FileExist
Функция проверки
существования физического
файла
InitStack
Процедура
инициализации стека
EmptyStack
Функция
проверки пустоты стека
Stack
Модуль для работы
со стекомс
InStack
Процедура
добавления
элемента
в стек
Рис. 6. Структурная диаграмма программы
18
OutStack
Процедура извлечения элемента из стека
В разделе Общие сведения указываются обозначение и наименование
программы, программное обеспечение (операционная среда, прикладные
программы), необходимое для функционирования описываемой программы. Если для различных режимов обработки требуются разные прикладные программы, следует дать таблицу, которая показывает, какое программное обеспечение требуется для каждого режима. Необходимо указать
язык программирования, на котором написана программа.
В разделе Функциональное назначение определяется класс решаемых
задач и (или) назначение программы. В этом пункте следует четко перечислить все функции, которые программа выполняет в установленном порядке или по выбору пользователя. Необходимо указать ограничения на
применение программы.
В разделе Описание логической структуры приводится структурная
диаграмма программы, в которой указываются имена и назначение составляющих модулей и подпрограмм (рис. 6). Словесное описание структурных единиц программы сопровождается представлением укрупненных
схем алгоритмов, в целом, не более трех листов. На первом листе приводится укрупненная схема алгоритма функционирования главной программы. Кроме этого, представляются схемы алгоритмов тех подпрограмм, которые отображают суть метода решения задачи. Примеры схем алгоритмов
приведены на рис. 7, 8, 9, 10.
Оформление схем алгоритмов должно соответствовать требованиям
ГОСТ 19.701-90 Схемы алгоритмов, программ, данных и систем.
Первым блоком в любой схеме является блок НАЧАЛО:
Начало
Соединительные линии в схеме, называемые иначе линиями потока,
не должны пересекаться, для этого применяются внутристраничные соединители:
19
2
или
2
и межстраничные соединители
4
4
[на лист…
[с листа…
Стрелка, направленная к соединителю, означает, что управление передается блоку, номер которого указан внутри соединителя. Стрелка,
направленная от соединителя, означает, что управление передается от блока, номер которого указан внутри соединителя. Каждая схема алгоритма
для отдельной программной единицы изображается на отдельном рисунке.
Рисунки нумеруются подряд внутри одного документа. Каждый рисунок
имеет название и номер, которые пишутся под рисунком. Названием рисунка с изображением схемы алгоритма может служить наименование
соответствующей программной единицы, например: «Схема алгоритма
программы контроля» или «Схема алгоритма подпрограммы Error». Примеры схем алгоритмов приведены на рис. 7, 8, 9, 10.
При сопровождении программного средства описание логической
структуры является материалом, по которому находится та часть текста
программы, которую нужно модифицировать или модернизировать. При
описании логики работы программы в соответствии с приводимой схемой
алгоритма необходимо описать работу, выполняемую каждым блоком.
В разделе Используемые технические средства необходимо указать
типы ЭВМ, конфигурацию вычислительного комплекса, для которого разработано описываемое программное средство. Если программа учитывает
особенности операционной среды, то следует указать ту операционную
среду, в которой работает эта программа.
20
Начало
PROG
Ввод
nameFT
Да
Нет
FileExist
Вывод
сообщ. об
ошибке
Brackets
Ввод s
NOT
s in [‘Д’, ‘д’,‘Y’,‘y’]
PROG
Not (s in [‘Д’, ‘д’, ‘Y’, ‘y’])
Конец
Рис. 7. Схема алгоритма программы Control
Вход
Вход
Assign
n
Reset
Да
IOResult=0
FileExist:=TRUE
Нет
1
Вывод
сообщ. 1
2
Вывод
сообщ. 2
3
Вывод
сообщ. 3
FileExist:=FALSE
Close
Выход
Рис. 8. Функция FileExist
Выход
Рис. 9. Процедура Error
21
Вход
Подготовка
к работе с файлом
InitStack
EOF
Not EOF
EO
Not
Ввод
из FT
‘(’,‘[’,‘{’
‘}’,‘]’,‘)’
s
InStack
Да
OutStack
NOT
Нет
EmptyStack
Exit
sk
‘(’
‘[’
sz:= ‘)’
sz:= ‘]’
‘{’
sz:= ‘}’
Проверка
совпадения
скобок
EOLN
Пропуск
строки
EOF
Закрытие
файла
Проверка
пустоты стека
Выход
Рис. 10. Схема алгоритма процедуры Brackets
22
Error
В разделе Вызов и загрузка указывается способ вызова программы с
соответствующего носителя данных и входные параметры при запуске
программы. Допускается указывать объем программы, сведения об использовании оперативной и внешней памяти. Необходимо указать, как
фактически начинается выполнение программы, какие сообщения ожидаются в течение этого начального периода.
В разделе Входные данные необходимо указать характер, организацию и предварительную подготовку входных данных. Необходимо описать
все типы входных данных, назначение каждого типа. Если входная информация может быть представлена последовательностью некоторых крупных
логических единиц, то необходимо описать способы объединения входных
данных в эти более крупные логические единицы. Необходимо указать
формат и назначение всех полей логической записи данных. Необходимо
указать также ограничения на размеры и количество входных данных.
Выходные данные описываются с той же степенью подробности, что
и входные. Если выходными данными являются одно или несколько сообщений, то необходимо указать, как пользователь должен интерпретировать
каждое сообщение, как он может использовать информацию, содержащуюся в каждом сообщении.
2.3. Требования к содержанию документа Описание применения
ГОСТ 19.101-77 определяет программный документ «Описание применения» как совокупность сведений о назначении программы, области
применения, применяемых методах, классе решаемых задач, ограничениях
применения и минимальной конфигурации технических средств.
Согласно ГОСТ 19.502-78 этот документ должен содержать четыре
составные части, которые уже упоминались выше. Титульная, информационная и часть регистрации изменений оформляются по общим правилам.
Основная часть документа должна состоять из следующих разделов:
23
– назначение программы,
– условия применения,
– описание задачи (определения, метод и алгоритм решения),
– входные и выходные данные,
– основные характеристики занимаемой памяти,
– пример использования.
В разделе Назначение программы описывается в общих чертах
назначение, возможности и предполагаемое использование программы.
Необходимо указать основные характеристики и ограничения на область
применения.
В разделе Условия применения необходимо указать операционную
среду, в которой должна работать программа, перечислить необходимые
компоненты операционной системы и оборудование, обеспечивающее выполнение задачи. В случае необходимости, следует указать требования
к другим программам, которые будут работать совместно с описываемой
программой, а также требования организационного, технического и технологического характера. Целесообразно указать общие характеристики
входной и выходной информации.
В разделе Описание задачи приводятся постановка задачи и математическая модель, описывается метод решения задачи. При описании метода решения необходимо сформулировать определения используемых понятий. Метод решения описывается словами с использованием математических формул и рисунков, необходимых для объяснения сути задачи.
В этом же разделе описывается интерфейс пользователя, его возможности, удобства, предоставляемые пользователю, наличие в программе
проверок корректности (допустимости) входных данных. Именно в этом
разделе должны быть приведены все возможные сообщения, выдаваемые
пользователю в ходе работы программы. Сообщения должны иметь соответствующие комментарии и должны быть снабжены перечнем необходи24
мых действий пользователя (или оператора системы), которые выполняются при получении им данного сообщения. В данном разделе целесообразно
привести конкретные примеры состояния задачи, либо данных, которые
могут вызвать соответствующие сообщения.
В разделе Входные и выходные данные необходимо перечислить
каждый новый тип входных данных и кратко описать назначение каждого
типа. Целесообразно привести схему, иллюстрирующую формат каждого
типа данных, дать необходимые пояснения и примеры. Далее аналогично
следует описать выходные данные, при этом указать все возможные виды
и способы выдачи пользователю выходных данных.
Если входные или выходные данные объединяются в некоторые логические группы, типа блоков или файлов, необходимо описать каждую
логическую группу с точки зрения ее назначения и дать ее характеристику
с точки зрения стандартных структур хранения в используемой операционной среде (типы файлов, типы носителей и т. п.). Если не существует
способов определения конца файлов, поддерживаемых собственно средствами операционной системы, необходимо указать, какой набор символов
в данных будет интерпретироваться как конец заполнения информации,
либо как конец файла.
В разделе Основные характеристики занимаемой памяти необходимо привести как характеристики занимаемой оперативной памяти программным комплексом в целом, так и каждым отдельным модулем.
Если программа в процессе работы использует внешнюю память, то
должны быть приведены также основные характеристики внешней памяти,
которая требуется для работы описываемого программного продукта.
В разделе Пример использования должно быть несколько конкретных
тестовых примеров, на которых велась отладка программы. Если программа работает в диалоговом режиме, то в данном разделе должны быть приведены примеры возможных диалогов с соответствующими комментария25
ми. Особое внимание при описании примеров должно быть уделено реакции программной системы на некорректные данные, на ошибки при ведении диалога, на предельные или экстремальные ситуации.
2.4. Требования к содержанию документа Спецификация
ГОСТ 19.101-77 определяет программный документ «Спецификация»
как состав программы и документации на нее. Согласно ГОСТ 19.202-78
программный документ «Спецификация» должен состоять из титульной,
основной части и части регистрации изменений. Информационная часть
(аннотация и содержание) в данном документе является необязательной.
Основная часть в общем случае содержит разделы: документация,
комплексы и компоненты.
В разделе Документация перечисляются программные документы,
подготовленные в курсовой работе. Разделы Комплексы и Компоненты
отражают структуру программы.
Заполнение части регистрации изменений такое же, как и в остальных
программных документах.
Вид бланка спецификации приведен на рис. 11. В графе «Обозначение» запись производят в одну строку. В остальных графах спецификации
записи допускаются в несколько строк. Наименование каждого раздела
спецификации указывают в графе «Наименование".
В раздел Документация вносятся обозначения подготовленных на
данный программный продукт документов, кроме документа «Спецификация» в порядке возрастания кода вида документа, входящего в обозначение
документа. В разделе «Наименование» указывается наименование программного продукта и вид документа. В графу «Примечания» заносятся
дополнительные сведения, относящиеся к записанным в спецификации документам.
26
Разделы Комплексы и Компоненты являются необязательными при
подготовке документа «Спецификация». Пример заполнения основной части программного документа «Спецификация» приведен в Приложении Б.
20
10
Обозначение
Наименование Примечание
80
70
20
30
10
297
20
210
Рис. 11. Вид бланка основной части документа «Спецификация» на формате
стандартного листа
27
Список использованных источников
1. Единая система программной документации. М., Государственный
комитет СССР по стандартам, 1982.
2. Уолш Д. Руководство по созданию документации для математического обеспечения. М.: Наука, 1980.
3. Майерс Г. Надежность программного обеспечения. М.: Мир, 1980.
4. Ван Тассел Д. Стиль, разработка, эффективность, отладка и испытание программ. М.: Мир. 1985.
5. Гласс Р. Руководство по надежному программированию. М.: Финансы и статистика, 1982.
6. Лингер Р., Миллс Х., Уитт Б. Теория и практика структурного программирования. М.: Мир, 1982.
28
ПРИЛОЖЕНИЕ А
Список ГОСТов Единой Системы Программной Документации
ГОСТ 19.001-77
ГОСТ 19.002-80
ГОСТ 19.003-80
ГОСТ 19.004-80
ГОСТ 19.101-77
ГОСТ 19.102-78
ГОСТ 19.103-78
ГОСТ 19.104-78
ГОСТ 19.105-78
ГОСТ 19.106-78
ГОСТ 19.201-78
ГОСТ 19.202-78
ГОСТ 19.301-79
ГОСТ 19.401-78
ГОСТ 19.402-78
ГОСТ 19.403-79
ГОСТ 19.404-79
ГОСТ 19.501-78
ГОСТ 19.502-78
ГОСТ 19.503-79
Общие положения.
Схемы алгоритмов программ. Правила выполнения.
Схемы алгоритмов и программ. Обозначения условные
графические.
Термины и определения.
Виды программ и программных документов.
Стадии разработки.
Обозначения программ и программных документов.
Основные надписи.
Общие требования к программным документам.
Требования к программным документам, выполненным
печатным способом.
Техническое задание. Требования к содержанию
и оформлению.
Спецификация. Требования к содержанию и оформлению.
Программа и методика испытаний. Требования к содержанию и оформлению.
Текст программы. Требования к содержанию
и оформлению.
Описание программы. Требования к содержанию
и оформлению.
Ведомость держателей подлинников.
Пояснительная записка. Требования к содержанию
и оформлению.
Формуляр. Требования к содержанию и оформлению.
Описание применения. Требования к содержанию
и оформлению.
Руководство системного программиста. Требования
к содержанию и оформлению.
29
ГОСТ 19.504-78
ГОСТ 19.505-79
ГОСТ 19.506-79
ГОСТ 19.507-79
ГОСТ 19.508-79
ГОСТ 19.601-78
ГОСТ 19.602-78
ГОСТ 19.603-78
ГОСТ 19.604-78
30
Руководство программиста. Требования к содержанию
и оформлению.
Руководство оператора. Требования к содержанию
и оформлению.
Описание языка. Требования к содержанию и оформлению.
Ведомость эксплуатационных документов.
Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
Общие правила дублирования, учета и хранения.
Правила дублирования, учета и хранения программных
документов, выполненных печатным способом.
Общие правила внесения изменений.
Правила внесения изменений в программные документы, выполненные печатным способом.
ПРИЛОЖЕНИЕ Б
Пример заполнения основной части программного документа
«Спецификация»
Обозначение
Наименование
44.4241.14 – 12
Документация
Комплекс программ моделирования
дискретных случайных процессов.
Текст программы.
44.4241.14 - 13
Комплекс программ моделирования
дискретных случайных процессов.
Описание программы.
44.4241.14 - 31
Комплекс программ моделирования
дискретных случайных процессов.
Описание применения.
Примечание
31
ПРИЛОЖЕНИЕ В
Основные элементы графического изображения схем алгоритмов
и программ
Схема алгоритма – это графическое изображение алгоритма, его отдельных элементов – блоков, изображенных на бумаге в виде стандартизованных геометрических символов. Наименования основных блоков, отображаемые ими функции, форма и размеры символов, правила выполнения
схем определяются ГОСТ 19.701-90. Каждый блок, кроме блоков Начало
и Конец, имеет один вход и один или несколько выходов, обозначаемых
линиями потока, входящими и выходящими из данного блока. Блок Начало имеет только выход, а блок Конец – только вход.
32
СОДЕРЖАНИЕ
Введение ............................................................................................................. 3
1. Виды программных документов и устанавливающие их госты .............. 4
2. Содержание основной части программных документов .......................... 13
2.1. Требования к содержанию документа текст программы ................... 13
2.2. Требования к содержанию документа описание программы ............ 17
2.3. Требования к содержанию документа описание применения........... 23
2.4. Требования к содержанию документа спецификация........................ 26
Список использованных источников .............................................................. 28
Приложение А. Список гостов единой системы программной
документации..................................................................................................... 29
Приложение Б. Пример заполнения основной части программного
документа «спецификация» ............................................................................. 31
Приложение В. Основные элементы графического изображения схем
алгоритмов и программ .................................................................................... 32
Документ
Категория
Без категории
Просмотров
0
Размер файла
1 084 Кб
Теги
barikov, 064127e175
1/--страниц
Пожаловаться на содержимое документа