Программы и программные документы
Разработка программ и программной документации регламентируется стандартами ЕСПД вне зависимости от назначения и области их применения.
Виды программных документов, разрабатываемых на разных стадиях проектирования, и их коды, в соответствии с ГОСТ 19.101, приведены в таблице 7.1.
Компонент — это программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.
Комплекс — это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции.
Таблица 7.1 — Виды программных документов по ГОСТ 19.101
Код вида документа | Вид документа | Стадии разработки | |||
Эскизный проект | Технический проект | Рабочий проект | |||
Компонент | Комплекс | ||||
— | Спецификация | — | — | Ø | • |
Ведомость держателей подлинников | — | — | — | О | |
Текст программы | — | — | О | О | |
Описание программы | — | — | О | О | |
Ведомость эксплуатационных документов | — | — | О | О | |
Формуляр | — | — | О | О | |
Описание применения | — | — | О | О | |
Руководство системного программиста | — | — | О | О | |
Руководство программиста | — | — | О | ||
Руководство оператора | — | — | О | О | |
Описание языка | — | — | О | О | |
Руководство по техническому обслуживанию | — | — | О | О | |
Программа и методика испытаний | — | — | О | О | |
Пояснительная записка | О | О | — | — | |
90—99 | Прочие документы | О | О | О | О |
Условные обозначения
Ø — документ обязательный;
• — документ обязательный для компонентов, имеющих самостоятельное применение;
О — необходимость составления документа определяется на этапе разработки и утверждения ТЗ;
— — документ не составляют.
Каждый программный документ должен состоять из следующих условных частей:
• титульной;
• информационной;
• основной;
• регистрации изменений.
Структура обозначения программ и программных документов установлена ГОСТ 19.103.
Требования к программным документам, выполняемым печатным способом, даны в ГОСТ 19.106, а к тексту программы — в ГОСТ 19.401.
Титульная часть программного документа состоит из листа утверждения (ЛУ) и титульного листа (ТЛ), выполняемых на бумаге формата А4. Формы ЛУ и ТЛ регламентированы ГОСТ 19.104.
Информационная часть программного документа состоит из двух элементов: аннотации и содержания (перечня). Аннотация представляет собой краткое изложение всего программного документа. Ее размещают на отдельной (пронумерованной) странице с заголовком Аннотация (без кавычек и без нумерации как раздела). В содержание входит перечень записей (например, в виде оглавления) о структурных элементах основной части документа. Каждая такая запись содержит: обозначение структурного элемента (номер раздела, подраздела и т. д.); наименование структурного элемента; адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т. п.). Содержание размещают после аннотации на отдельной странице с заголовком Содержание (без кавычек и без нумерации как раздела). Правила оформления информационной части установлены в ГОСТ 19.105.
Основная часть программного документа содержит текст документа (с наименованием разделов), рисунки, таблицы и т. п. В основную часть включают: перечень терминов и определений, перечень сокращений, приложения, предметный указатель и перечень ссылочных документов. Оформление основной части программного документа регламентировано в ГОСТ 19.105.
Часть регистрации изменений фиксирует внесение (удаление) нового изменения. Оформление регламентирует ГОСТ 19.603.
Структура обозначения программы и ее программного документа — спецификации по ГОСТ 19.103 следующая:
А.В. ХХХХХ — XX
где А — код страны;
В — код организации разработчика;
ХХХХХ — регистрационный номер в соответствии с классификатором программ;
XX — номер издания программы.
К вышеуказанному обозначению добавляются дополнительные цифры:
XX — код вида документации;
XX — номер документа данного вида;
X — номер части документа, если они есть.
Программная документация в ДП (ДР) в учебном заведении может быть оформлена следующим образом:
• полностью в соответствии с требованиями стандартов ЕСПД, т. е. оформляется как отдельная часть или раздел пояснительной записки;
• включением в ПЗ отдельных программных документов, например, схемы алгоритма программы, текста программы и выполненные, в соответствии с требованиями стандартов ЕСПД, включаются в ПЗ в виде приложений и иллюстраций (рисунки).
В случае использования разработанного ранее программного средства вместо описания программы в проекте должно быть приведено описание возможностей данного программного средства и технологии его использования, оформленное как документ.
Выполнение и оформление составных частей регламентируются следующими стандартами.
ГОСТ 19.103 устанавливает структуру обозначения программ и программных документов;
ГОСТ 19.104 устанавливает правила оформления титульной части программного документа;
ГОСТ 19.105 устанавливает правила оформления информационной и основной части программного документа;
ГОСТ 19.106 устанавливает требования к программным документам, выполняемым печатным способом;
ГОСТ 19.603 регламентирует оформление регистрации изменений в программном документе;
ГОСТ 19.701 (взамен ГОСТ 19.002 и ГОСТ 19.003) устанавливает в соответствии с международным стандартом ICO 5807-85 правила применения условных обозначений для схем: данных, программ, работы системы, взаимодействия программ и ресурсов системы.
Каждый программный документ по составу и структуре оформляется в соответствии с требованиями конкретного стандарта ЕСПД. Например,
ГОСТ 19.202 устанавливает форму и порядок основного обязательного документа — спецификации;
ГОСТ 19.401 устанавливает требования к содержанию обязательного программного документа — текст программы,
ГОСТ 19.402 устанавливает требования к программному документу — описание программы;
ГОСТ 19.404 устанавливает требования к содержанию программного документа — пояснительной записки.
Допускается внутривузовское обозначение программных документов.
В ПГАТИ принята следующая структура обозначения программных документов:
ПГАТИ.ХХХХХХ.ХХХ-ХХ
где ХХХХХХ — специальность и кафедра, например 2007 и индекс кафедры 34;
XXX — порядковый регистрационный номер документа;
XX — код документа (см. таблицу 7.1 пособия).
Устанавливаются три способа выполнения программных документов: 1) машинописный (допускается и рукописный); 2) машинный способ (на ЭВМ); 3) типографский.
Каждый программный документ оформляется в соответствии с требованиями стандартов ЕСПД, например: спецификация (ГОСТ 19.202); описание программы (ГОСТ 19.402); пояснительная записка (ГОСТ 19.404) и др.
Дата добавления: 2014-12-27; просмотров: 2181;