Министерство образования и науки российской федерации

Федеральное государственное автономное образовательное учреждение

высшего профессионального образования

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

университет аэрокосмического приборостроения»

__________________________________________________________________

Кафедра Вычислительных систем и сетей (№44)

Документирование программного обеспечения

Методические указания

к выполнению курсовой работы

Санкт-Петербург

2013

Составитель: Л.Н.Бариков

Рецензент: канд. техн. наук В.А.Галанина.

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

Предназначено для студентов очной, очно-заочной (вечерней) и заочной форм обучения по направлению 230100.62 «Информатика и вычислительная техника» (профиль – Вычислительные машины, комплексы, системы и сети).

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

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

аэрокосмического приборостроения (СПбГУАП). 2013.

Подписано к печати Формат 60х84 1/16

Объем 1,6 п.л. Уч.-изд. л. 1,6 Тираж 150 экз.

Зак. №

Ротапринт ГУАП 190000, Санкт-Петербург, ул. Б.Морская, 67

Введение

Курсовое проектирование является завершающим и одним из важнейших этапов подготовки специалистов по дисциплине “Программирование. Программирование на языках высокого уровня”. Одной из основных целей этого этапа является обучение студентов оформлению необходимой программной документации на разработанное программное средство в соответствии с требованиями ЕСПД.

Предлагаемое пособие содержит информационный материал, необходимый студентам очной, очно-заочной (вечерней) и заочной форм обучения по направлению 230100.62 «Информатика и вычислительная техника» (профиль – Вычислительные машины, комплексы, системы и сети), при выполнении курсового проекта, предусмотренного учебным планом по дисциплине “Программирование. Программирование на языках высокого уровня”. Предлагаемый информационный материал обеспечивает выполнение всех требований по оформлению программных документов, которые определены ГОСТами ЕСПД к набору программных документов при сдаче программного продукта в Государственный Фонд Алгоритмов и Программ.

1 Виды программных документов и устанавливающие их госТы

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

С этого момента любой программный продукт, предназначенный для широкого (в том числе, и коммерческого) использования, должен сопровождаться определённым набором программной документации. В зависимости от назначения и сложности программного продукта состав этого набора может меняться. Но в любом случае каждый документ, входящий в этот набор, должен строго соответствовать ГОСТу на этот документ.

ГОСТ 19781-74 "Машины вычислительные. Программное обеспечение. Термины и определения" определяет программу как алгоритм, записанный в форме, воспринимаемой вычислительной машиной. Многообразие типов программных документов определяет ГОСТ 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.103-77. При курсовом проектировании примем следующую форму обозначения: