ДОКУМЕНТИРОВАНИЕ И СТАДИИ РАЗРАБОТКИ ПРОГРАММЫ

Программа, как правило, разрабатывается не для того, кто яв­ляется ее автором. Программу необходимо разрабатывать так, чтобы было понятно, как ее запускать, какой метод решения задачи в ней заложен, каковы требования к вводу (выводу) и т.д. Например, если в программной документации не указана размерность вводимых дан­ных, то пользователь будет в большом затруднении при работе с та­кой программой.

При разработке программной докумен­тации нужно придерживаться государственных стандартов, объединен­ных в Единую систему программной документации (ЕСПД).

Согласно ГОСТ 19.101-77 «Виды программ и программных доку­ментов» программы делятся на компоненты и комплексы. Компонент - это программа, рассматриваемая как единое целое, выполняющая за­конченную функцию и применяемая самостоятельно или в составе комплекса. Комплекс - это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функ­ции, и применяемая самостоятельно или в составе другого комплекса.

Указанный стандарт определяет в качестве программных документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программы. Все документы делятся на две группы: программные (таблица1) и эксплуатационные (таблица 2).

 

Таблица 1

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

Таблица 2

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

Строгой регламентации перечня документов для каждой программы ГОСТ 19.101—77 не устанавливает, так как сложность программы и условия ее эксплуатации могут варьиро­ваться в таких широких пределах, что невозможно точно указать, какая именно документация должна быть разработана в каждом конкретном случае. По этой причине ГОСТ 19.101-77 допускает объединение отдельных видов эксплуатационных документов (за исключением ведомости эксплуатационных документов и форму­ляра).

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

Техническое задание*.

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

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

Программу и методику испытаний (тестирования).

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

Поскольку вся документация, разрабатываемая в процессе вы­полнения курсовой работы, должна отвечать требованиям ЕСПД, ниже приводится необходимая часть содержания стандартов.

 

Общие сведения о ЕСПД

Согласно ГОСТ 19.001—93 «Единая система программной доку­ментации. Общие требования», ЕСПД - это комплекс государ­ственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.

Регламентация указанных процессов обеспечивает возмож­ность:

- унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в но­вых разработках;

- снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации про­граммных изделий;

- автоматизации изготовления и хранения программной документации.

Каждый документ должен иметь титульный лист и лист утвержде­ния. Правила их заполнения регламентируются ГОСТ 19.104-78 «Еди­ная система программной документации. Основные надписи».

На титульный лист и лист утверждения выносятся следующие надписи: наименование министерства; наименование документа: обозначение документа; сведения о носителе данных, на котором представлен подлинник; общее количество листов утверждения; объем документа; сведения о разработчике; подпись нормоконтролера; отметка об учете и хранении; сведения об изменениях.

Лист утверждения оформляется на каждый программный до­кумент на листах формата А4 (ГОСТ 2.301—68) независимо от вида документа, который может быть выполнен на любом носителе данных.

Обозначение листа утверждения состоит из обозначения доку­мента, к которому он относится, и через дефис — шифра листа утверждения. Лист утверждения не входит в общее количество листов документа. Лист утверждения хранится на предприятии-держателе подлинника документа. Копии листа утверждения вы­сылают заказчику и головному предприятию.

Программные документы подразделяются в зависимости от способа выполнения и характера применения на подлинники, дубликаты и копии (ГОСТ 2.102—68), предназначенные для разработки, сопровождения и эксплуатации программы.

Титульный лист заполняют по форме и правилам, установленным для листа утверждения.

Правила оформления последующих листов программных документов регламентируется ГОСТ 19.105—78 «Единая система программной документации. Общие требования к программной документации».

Согласно этому стандарту программный документ состоит из следующих условных частей:

- титульной;

- информационной;

- основной;

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

Титульная часть состоит из листа утверждения и титульного листа.

Информационная часть включает аннотацию и содержание (перечень разделов, подразделов с указанием номеров страниц). В аннотации приводятся сведения о назначении документа и краткое изложение его основной части.

Состав и структура основной части программного документа устанавливается другими стандартами ЕСПД (с частью из них мы познакомимся ниже).

Программные документы выполняют на листах формата А4         (ГОСТ 2.306-68).

Материалы программного документа располагают в последовательности: титульная часть:

лист утверждения;

титульный лист (первый лист документа);

информационная часть:

аннотация;

лист содержания;

основная часть:

текст документа (с рисунками, таблицами и т. п.);

приложения;

перечень терминов;

перечень сокращений;

перечень рисунков;

перечень таблиц;

предметный указатель;

перечень ссылочных документов;

перечень символов и числовых коэффициентов;

часть регистрации изменений;

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

Составляющие основной части, начиная от приложения и далее, выполняются при необходимости.

Рассматриваемый ГОСТ 19.106-78 устанавливает правила оформления, размещения в документе и нумерации текста, рисунков, таблиц и формул (из-за ограниченности объема методических указаний они здесь не приводятся).

Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформить в виде приложений. Приложения оформляют как продолжение данного документа или выпускают в виде отдельного документа. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголо­вок, записываемый симметрично тексту прописными буквами. На прило­жения должны быть даны ссылки в основном документе. Все приложения должны быть перечислены в листе «Содержание».

Содержание программных документов

В данном подразделе приводятся сведения о содержании лишь тех документов, оформление кото­рых является обязательным при выполнении курсовой работы.

Техническое задание

Порядок построения и оформления технического задания (ТЗ) на разработку программы или программного изделия устанавли­вается             ГОСТ 19.201-78 «Единая система программной документа­ции. Техническое задание. Требования к содержанию и оформле­нию».

На ТЗ оформляются лист утверждения и титульный лист. В документ не включаются информационная часть и лист регистра­ции изменений. Изменения и дополнения в Т3 на последующих стадиях разработки оформляют в виде дополнения к нему. ТЗ содержит следующие разделы:

- введение (наименование, краткая характеристика области применения программы и объекта, в котором исполь­зуют программу);

- основание для разработки (документы), на базе которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и (или) условное обозначение темы разработки;

- назначение разработки (функциональное и эксплуатационное назначение программы);

- требования к программе или программному изделию (см. ниже);

- требования к программной документации (состав и специальные требования к ней);

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

- стадии и этапы разработки (содержание работ на каж­дом этапе, сроки и исполнители);

- порядок контроля и приемки (виды испытаний и общие требования к приемке работы).

В зависимости от особенностей программы допускается уточнять содержание разделов, вводить новые разделы или объе­динять некоторые из них.

Раздел «Требования к программе или программному изделию» должен содержать подразделы:

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

- требования к надежности;

- условия эксплуатации (для выбранных типов носителей данных);

- требования к составу и параметрам технических средств (их основные технические характеристики);

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

- требования к маркировке и упаковке;

- требования к транспортировке и хранению;

- специальные требования.

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

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

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

Требования к описанию программы устанавливает ГОСТ 19.402—78 «Единая система программной документации. Описание программы». Согласно этому стандарту составление информационной части (аннотации и содержания) не обязательно. Описание программы должно включать разделы:

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

- функциональное назначение (классы решаемых задач и/или назначение программы и сведения о функциональ­ных ограничениях на применение);

- описание логической структуры (алгоритм программы, используемые методы, структура программы с описанием функции составных частей и связи между ними, связи программы с другими программами);

- используемые технические средства (для работы программы);

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

- входные данные (характер и организация, формат, опи­сание и способ кодирования входных данных);

- выходные данные (то же, что и для входных данных).

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