Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Краткий алгоритм оформления программы
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
Оформление программного документа
Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
Общие требования к программным документам. ГОСТ 19.105 - 78
Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78
ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
Материалы программного документа должны располагаться в следующей последовательности :
- Титульная часть:
- лист утверждения (не входит в общее количество листов документа);
- титульный лист (первый лист документа);
- Информационная часть:
- аннотация;
- лист содержания;
- Основная часть:
- текст документа (с рисунками, таблицами и т.п.);
- приложения;
- перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
- часть регистрации изменений:
- лист регистрации изменений.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
Форматирование текста:
- Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
- Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
- Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
- Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
- Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
- Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
- при выполнении документа машинописным способом - двум интервалам.
- Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
- при выполнении документа машинописным способом - трём машинописным интервалам.
- Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
- В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
- Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
- При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
- Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
- Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
- Необходимые пояснения к тексту документа могут оформляться сносками.
- Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
- Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
- Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
- Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
- Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
- В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
- Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
- В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
- Одно примечание не нумеруется. После слова «Примечание» ставят точку.
- Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
- Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
- Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
- Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
На верх
ГОСТ 19.105-78* (Общие требования к программным документам)
Из
данного ГОСТа мы получаем
общие требования к оформлению
программных документов.
Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
- Программный документ состоит из следующих условных частей:
- титульной;
- информационной;
- основной;
- регистрации изменений.
- Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 19.104-78.
- Информационная часть должна состоять из аннотации и содержания.
- Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.
- В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
- Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:
- обозначение структурного элемента (номер раздела, подраздела и т.д.);
- наименование структурного элемента;
- адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.).
- Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
- Часть регистрации изменений (должна присуствовать в каждом программном документе)
- О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603-78.
==================================
ГОСТ 19.106-78* (Общие требования к программным документам, выполненным печатным
способом)
Из данного ГОСТа мы получаем общие правила для печатного способа выполнения программных документов . Ниже приведены наиболее важные разделы.
- Настоящий стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для печатного способа выполнения.
- Стандарт не распространяется на программный документ «Текст программы».
- Состав и структура программного документа устанавливается по ГОСТ 19.105-78.
- Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
- Программные документы оформляют:
- на листах формата А4 (ГОСТ 2.301-68) - при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата А3.
- Материалы программного документа располагают в следующей последовательности:
- титульная часть:
- лист утверждения (не входит в общее количество листов документа);
- титульный лист (первый лист документа);
- информационная часть:
- аннотация;
- лист содержания;
- основная часть:
- текст документа (с рисунками, таблицами и т.п.);
- приложения;
- перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
- часть регистрации изменений:
- лист регистрации изменений.
- Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
- В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.
- Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
- Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
- Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
- Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
- Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
- при выполнении документа машинописным способом - двум интервалам.
- Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
- при выполнении документа машинописным способом - трём машинописным интервалам.
- Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
- В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
- Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
- При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Пример структуры текста программного документа и
нумерации его разделов, подразделов, пунктов и подпунктов.
- Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
- Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
- Необходимые пояснения к тексту документа могут оформляться сносками.
- Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство 2) ...» или «бумага 5) ».
- Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
- Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
- Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
- Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
- В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
- Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
- В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
- Одно примечание не нумеруется. После слова «Примечание» ставят точку.
- Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
- Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
- Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
- Каждое приложение должно начинаться с новой
страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь
тематический заголовок, который записывают симметрично тексту прописными
буквами.
(в итоге, для создания проекта, нам понадобится только лист регистрации изменений).
- Настоящий стандарт устанавливает правила внесения изменений в программные документы, предусмотренные стандартами Единой системы программной документации (ЕСПД) и выполненные печатным способом.
На верх
==================================
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Система технической документации на АСУ |
ГОСТ 24.207-80 |
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ ПО ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ |
|
| System of technical documentation for computer control systems. Requirements for contents of documents on software |
Постановлением Государственного комитета СССР по стандартам от 14 мая 1980 г. № 2101 срок введения установлен
с 01.01 1981 г.
Настоящий стандарт распространяется на техническую документацию на автоматизированные системы управления (АСУ) всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает требования к содержанию документов, входящих в соответствии с ГОСТ 24.101-80 в состав документации программного обеспечения в проектах АСУ.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Документация программного обеспечения предназначена:
- для описания проектных решений по программному обеспечению в документе «Описание программного обеспечения АСУ».
- для установления требований к программе (комплексу программ) в документе «Техническое задание»;
- для описания решений, обеспечивающих сопровождение, изготовление и эксплуатацию программы (комплекса программ) в документах «Пояснительная записка», «Описание применения», «Описание программы», «Спецификация», «Руководство программиста», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний»;
- для проверки работоспособности программы (комплекса программ) в документе «Описание контрольного примера».
1.2. При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками соответствующей части.
1.3. В зависимости от назначения и специфических особенностей создаваемых АСУ допускается включать в документы дополнительные разделы, требования к содержанию которых не установлены настоящим стандартом. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.
1.4. Требования к содержанию документов «Техническое задание», «Пояснительная записка», «Описание применения», «Спецификация», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний» установлены ГОСТ 19.201-78 , ГОСТ 19.404-79 , ГОСТ 19.502-78 , ГОСТ 19.202-78 , ГОСТ 19.505-79 , ГОСТ 19.401-78 , ГОСТ 19.501-78 и ГОСТ 19.301-79 .
(Измененная редакция, Изм. № 1).
2. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
2.1. Описание программного обеспечения АСУ
2.1.1. Документ должен содержать вводную часть и разделы:
- структура программного обеспечения;
- основные функции частей программного обеспечения;
- методы и средства разработки программного обеспечения;
- операционная система;
- средства, расширяющие возможности операционной системы.
2.1.2. Вводная часть должна содержать основные сведения о техническом, информационном и других видах обеспечения АСУ, необходимые для разработки программного обеспечения, или ссылку на соответствующие документы проекта АСУ.
2.1.3. Раздел «Структура программного обеспечения» должен содержать перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
2.1.4. Раздел «Основные функции частей программного обеспечения» должен содержать подразделы, в которых для каждой части программного обеспечения приводят назначение и описание основных функций
(Измененная редакция, Изм. № 1).
2.1.5. Раздел «Методы и средства разработки программного обеспечения» должен содержать перечень методов программирования и средств разработки программного обеспечения АСУ с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
2.1.6. Раздел «Операционная система» должен содержать:
- наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;
- наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;
- требования к варианту генерации выбранной версии операционной системы.
2.1.7. Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать:
- наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источника, где дано подробное описание выбранного средства;
- наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное применение;
- требования к настройке используемого средства.
2.2. Описание программы
2.2.2. Для программы (комплекса программ), получаемой за счет использования ранее разработанных программных средств, документ «Описание программы» следует дополнять разделом «Настройка программных средств».
2.2.3. Раздел «Настройка программных средств» должен содержать:
- наименование, обозначение использованных программных средств, описание процедур, необходимых для их настройки, или ссылки на эксплуатационную документацию этих средств;
- перечень элементов использованных программных средств, необходимых для получения программы (комплекса программ);
- описание настройки на языке, предусмотренном в эксплуатационной документации на используемые программные средства.
2.3. Руководство программиста
2.3.1. Документ по составу разделов и их содержанию должен соответствовать ГОСТ 19.504-79 и, кроме того, включать раздел «Сведения о форме представления программы (комплекса программ)».
2.3.2. Раздел «Сведения о форме представления программы (комплекса программ)» должен содержать сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, а также сведения, необходимые для чтения информации с носителя.
2.3.3. Для программы (комплекса программ), допускающей настройку на условия конкретного применения, в документ «Руководство программиста» включают разделы:
- структура программы;
- настройка программы;
- дополнительные возможности;
- сообщения системному программисту.
2.3.4. Разрешается для программы (комплекса программ), допускающей настройку на условия конкретного применения, вместо разделов, перечисленных в п. 2.3.3, разрабатывать отдельный документ «Руководство системного программиста», удовлетворяющий требованиям ГОСТ 19.503-79 .
2.4. Описание контрольного примера
2.4.1. Документ должен содержать разделы:
- назначение;
- исходные данные;
- результаты расчета;
- проверка программы (комплекса программ).
2.4.2. Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функции, из числа реализуемых программой (комплексом программ), проверяемых контрольным примером.
2.4.3. Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы (комплекса программ) с приведением исходных данных. Допускается исходные данные представлять в виде распечатки с АЦПУ.
2.4.4. Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой (комплексом программ), позволяющие оценить правильность выполнения проверяемых функции и значение проверяемых параметров. Допускается результаты расчета приводить в виде распечатки с АЦПУ.
2.4.5. Раздел «Проверка программы (комплекса программ)» должен содержать:
- описание состава технических средств, необходимых для работы программы (комплекса программ), или ссылку на соответствующие программные документы;
- описание процедур формирования исходных данных для проверки программы (комплекса программ), вызова проверяемой программы (комплекса программ) и получения результатов расчета;
- описание действий оператора при подготовке исходных данных и проверке программы (комплекса программ) на контрольном примере.
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Единая система программной документации |
ГОСТ 19.101-77(СТ СЭВ 1626-79) |
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ |
|
|
United system for program documentation. |
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 срок введения установлен
с 01.01 1980 г.
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1
Таблица 1
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2,1.3.
2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл. 2.
Таблица 2
| Вид программного документа | Содержание программного документа |
|---|---|
| Спецификация | Состав программы и документации на нее |
| Перечень предприятий, на которых хранят подлинники программных документов | |
| Текст программы | Запись программы с необходимыми комментариями |
| Описание программы | Сведения о логической структуре и функционировании программы |
| Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля | |
| Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
(Измененная редакция, Изм. № 1).
2.3. Виды эксплуатационных документов и их содержание приведены табл.3.
Таблица 3
| Вид эксплуатационного документа | Содержание эксплуатационного документа |
|---|---|
| Перечень эксплуатационных документов на программу | |
| Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
| Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
| Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения | |
| Руководство программиста | Сведения для эксплуатации программы |
| Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
| Описание языка | Описание синтаксиса и семантики языка |
| Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
(Измененная редакция, Изм. № 1).
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл. 4.
Таблица 4
| Код вида документа | Вид документа | Стадии разработки | |||
|---|---|---|---|---|---|
| Эскизный проект | Технический проект | Рабочий проект | |||
| компонент | комплекс | ||||
| - | Спецификация | - | - | ||
| 05 | Ведомость держателей подлинников | - | - | - | |
| 12 | Текст программы | - | - | ||
| 13 | Описание программы | - | - | ||
| 20 | Ведомость эксплуатационных документов | - | - | ||
| 30 | Формуляр | - | - | ||
| 31 | Описание применения | - | - | ||
| 32 | Руководство системного программиста | - | - | ||
| 33 | Руководство программиста | - | - | ||
| 34 | Руководство оператора | - | - | ||
| 35 | Описание языка | - | - | ||
| 46 | Руководство по техническому обслуживанию | - | - | ||
| 51 | Программа и методика испытаний | - | - | ||
| 81 | Пояснительная записка | - | - | ||
| 90-99 | Прочие документы | ||||
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.
2.2-2.5. (Измененная редакция, Изм. № 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. № 1).
Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июне 1981 г (ИУС 9-81)
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Единая система программной документации |
ГОСТ 19.101-77 (СТ СЭВ 1626-79) |
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ |
|
United system for program documentation. Types of programs and program documents |
Дата введения с 01.01.80
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1
Таблица 1
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2,1.3.
2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл. 2.
Таблица 2
| Вид программного документа | Содержание программного документа |
|---|---|
| Спецификация | Состав программы и документации на нее |
| Перечень предприятий, на которых хранят подлинники программных документов | |
| Текст программы | Запись программы с необходимыми комментариями |
| Описание программы | Сведения о логической структуре и функционировании программы |
| Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля | |
| Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
(Измененная редакция, Изм. № 1).
2.3. Виды эксплуатационных документов и их содержание приведены табл.3.
Таблица 3
| Вид эксплуатационного документа | Содержание эксплуатационного документа |
|---|---|
| Перечень эксплуатационных документов на программу | |
| Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
| Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
| Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения | |
| Руководство программиста | Сведения для эксплуатации программы |
| Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
| Описание языка | Описание синтаксиса и семантики языка |
| Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
(Измененная редакция, Изм. № 1).
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл click . 4.
Таблица 4
| Код вида документа | Вид документа | Стадии разработки | |||
|---|---|---|---|---|---|
| Эскизный проект | Технический проект | Рабочий проект | |||
| компонент | комплекс | ||||
| - | Спецификация | - | - | ||
| 05 | Ведомость держателей подлинников | - | - | - | |
| 12 | Текст программы | - | - | ||
| 13 | Описание программы | - | - | ||
| 20 | Ведомость эксплуатационных документов | - | - | ||
| 30 | Формуляр | - | - | ||
| 31 | Описание применения | - | - | ||
| 32 | Руководство системного программиста | - | - | ||
| 33 | Руководство программиста | - | - | ||
| 34 | Руководство оператора | - | - | ||
| 35 | Описание языка | - | - | ||
| 46 | Руководство по техническому обслуживанию | - | - | ||
| 51 | Программа и методика испытаний | - | - | ||
| 81 | Пояснительная записка | - | - | ||
| 90-99 | Прочие документы | ||||
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.
2.2-2.5. (Измененная редакция, Изм. № 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. № 1).
Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июне 1981 г (ИУС 9-81)
Загрузка...