3. ДОКУМЕНТИРОВАНИЕ И СТАДИИ РАЗРАБОТКИ ПРОГРАММЫ
Программа, как правило, разрабатывается не для того, кто является ее автором. Программу необходимо разрабатывать так, чтобы было понятно, как ее запускать, какой метод решения задачи в ней заложен, каковы требования к вводу (выводу) и т.д. Например, если в программной документации не указана размерность вводимых данных, то пользователь будет в большом затруднении при работе с такой программой.
При разработке программной документации нужно придерживаться государственных стандартов, объединенных в Единую систему программной документации (ЕСПД).
Согласно ГОСТ 19.101-77 «Виды программ и программных документов» программы делятся на компоненты и комплексы. Компонент - это программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса. Комплекс - это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Указанный стандарт определяет в качестве программных документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программы. Все документы делятся на две группы: программные (таблица1) и эксплуатационные (таблица 2).
Вид программного документа | Содержание программного документа |
Спецификация | Состав программы и документации на нее |
Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Таблица 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 устанавливает правила оформления, размещения в документе и нумерации текста, рисунков, таблиц и формул (из-за ограниченности объема методических указаний они здесь не приводятся).
Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформить в виде приложений. Приложения оформляют как продолжение данного документа или выпускают в виде отдельного документа. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, записываемый симметрично тексту прописными буквами. На приложения должны быть даны ссылки в основном документе. Все приложения должны быть перечислены в листе «Содержание».
3.2. Содержание программных документов
В данном подразделе приводятся сведения о содержании лишь тех документов, оформление которых является обязательным при выполнении курсовой работы.
Порядок построения и оформления технического задания (ТЗ) на разработку программы или программного изделия устанавливается ГОСТ 19.201-78 «Единая система программной документации. Техническое задание. Требования к содержанию и оформлению».