Федеральное агентство по образованию российской федерации
Государственное образовательное учреждение высшего профессионального образования
«Санкт-Петербургский государственный университет
аэрокосмического приборостроения»
Кафедра вычислительных систем и сетей (№44)
ДОКУМЕНТИРОВАНИЕ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
Методические указания
к выполнению курсовой работы
Санкт-Петербург
2004 г.
Составители: Н.Н.Бровин, Л.В.Плющева
Рецензенты: кафедра теории передачи сигналов и теории нелинейных электрических цепей Санкт-Петербургского Государственного Электротехнического Университета Связи и Телекоммуникаций,
канд. техн. наук Г.В.Преснякова.
Содержатся методические указания к оформлению программной документации при курсовом проектировании. Требования по оформлению программных документов определены исходя из ГОСТов ЕСПД и набора программных документов, требуемых при сдаче программного продукта в Государственный Фонд Алгоритмов и Программ.
Предназначены для студентов специальности "Вычислительные машины, комплексы, системы и сети" дневной, вечерней и заочной форм обучения.
Подготовлены к публикации Кафедрой вычислительных систем и сетей по рекомендации методической комиссии Факультета вычислительных систем и программирования Санкт-Петербургского Государственного Университета Аэрокосмического Приборостроения.
С Санкт-Петербургский
Государственный Университет
Аэрокосмического Приборостроения.
( СПбГУАП ), 2004.
Подписано к печати Формат 60х84 1/16
Объем 2,0 п.л. Уч.-изд.л. 2,0 Тираж 500 экз.
Зак. № Бесплатно
Ротапринт СПбГУАП 190000, Санкт-Петербург, ул.Б.Морская, 67
1. Виды программных документов и устанавливающие их госТы
Одним из следствий развития программного обеспечения для ЭВМ явилось значительное расширение круга пользователей. Программисту на сегодняшний день приходится создавать и изучать большое количество документов, описывающих программное обеспечение. Стала очевидной необходимость стандартизации программной документации. В 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. При курсовом проектировании примем следующую форму обозначения: