Единая система программной документации. Оформление по еспд программной документации, еспд Виды программных документов
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01.1980 г.
Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
Стандарт соответствует СТ СЭВ 2088-80 в части общих требований к оформлению информационной части (см. справочное приложение).
1 . ОБЩИЕ ТРЕБОВАНИЯ
3 . ИНФОРМАЦИОННАЯ ЧАСТЬ
3.1 . Информационная часть должна состоять из аннотации и содержания.
3.2 Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.
3.3 . В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
3.4 . Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:
обозначение структурного элемента (номер раздела, подраздела и т. п.);
наименование структурного элемента;
адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т. п.);
Правила обозначения структурных элементов основной части документа и их адресации устанавливаются стандартами ЕСПД на привила оформления документов на соответствующих носителях данных.
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
Единая система программной документации |
ГОСТ 19.105-78(СТ СЭВ 2088-80) |
ОБЩИЕ ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ |
|
United system for program documentation. |
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01 1980 г.
Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
Стандарт соответствует СТ СЭВ 2088-80 в части общих требований к оформлению информационной части (см. справочное приложение)
1. ОБЩИЕ ТРЕБОВАНИЯ
1.1. Программный документ может быть представлен на различных типах носителей данных.
1.2. Программный документ состоит из следующих условных частей:
- титульной;
- информационной;
- основной;
- регистрации изменений.
1.3. Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
2. ТИТУЛЬНАЯ ЧАСТЬ
2.1. Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 19.104-78 .
3. ИНФОРМАЦИОННАЯ ЧАСТЬ
3.1. Информационная часть должна состоять из аннотации и содержания.
3.2. Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.
3.3. В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
- обозначение структурного элемента (номер раздела, подраздела и т.д.);
- наименование структурного элемента;
- адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.).
Правила обозначения структурных элементов основной части документа и их адресации устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
4. ОСНОВНАЯ ЧАСТЬ
4.1. Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
5. ЧАСТЬ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
5.1. О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603-78 .
ПРИЛОЖЕНИЕ
Справочное
ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.105-78
СТ СЭВ 2088-80
Разд. 3 ГОСТ 19.105-78 соответствует разд. 4 (пп. 4.2, 4.3) СТ СЭВ 2088-80.
(Введено дополнительно. Изм. № 1)
* Переиздание (ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)
ГОСТ 19.105-78
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
ОБЩИЕ ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ
Unified system for program documentation. General requirements for program documents
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 18 декабря 1978 г. N 3350 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
Стандарт соответствует СТ СЭВ 2088-80* в части общих требований к оформлению информационной части (см. приложение).
________________
* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей . - Примечание изготовителя базы данных.
(Измененная редакция, Изм. N 1).
1. ОБЩИЕ ТРЕБОВАНИЯ
1. ОБЩИЕ ТРЕБОВАНИЯ
1.1. Программный документ может быть представлен на различных типах носителей данных.
1.2. Программный документ состоит из следующих условных частей:
титульной;
информационной;
основной;
регистрации изменений.
1.3. Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
2. ТИТУЛЬНАЯ ЧАСТЬ
2.1. Титульная часть состоит из листа утверждения и титульного листа.
Правила оформления листа утверждения и титульного листа - по ГОСТ 19.104-78 .
3. ИНФОРМАЦИОННАЯ ЧАСТЬ
3.1. Информационная часть должна состоять из аннотации и содержания.
3.2. Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.
3.3. В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
3.4. Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:
обозначение структурного элемента (номер раздела, подраздела и т.п.);
наименование структурного элемента;
адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.).
Правила обозначения структурных элементов основной части документа и их адресации устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
4. ОСНОВНАЯ ЧАСТЬ
4.1. Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
5. ЧАСТЬ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
5.1. О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603-78 .
ПРИЛОЖЕНИЕ (справочное). ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.105-78 СТ СЭВ 2088-80
ПРИЛОЖЕНИЕ
Справочное
Разд.3 ГОСТ 19.105-78 соответствует разд.4 (пп.4.2, 4.3) СТ СЭВ 2088-80.
(Введено дополнительно, Изм. N 1).
Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сборник национальных стандартов. -
М.: Стандартинформ, 2010
На верх
ГОСТ 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 см, проведённой в левой части страницы.
- Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
- Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
- Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
- В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
- Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
- В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
- Одно примечание не нумеруется. После слова «Примечание» ставят точку.
- Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
- Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
- Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
- Каждое приложение должно начинаться с новой
страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь
тематический заголовок, который записывают симметрично тексту прописными
буквами.
(в итоге, для создания проекта, нам понадобится только лист регистрации изменений).
- Настоящий стандарт устанавливает правила внесения изменений в программные документы, предусмотренные стандартами Единой системы программной документации (ЕСПД) и выполненные печатным способом.
На верх
==================================
Комплекс стандартов на автоматизированные системы (КСАС)
Единая система программной документации (ЕСПД) - отечественный комплекс стандартов на программную документацию . В профессиональном просторечии его еще называют «девятнадцатым гостом» , что не совсем правильно, поскольку речь идет не об одном, а примерно о 30 разных нормативно-технических документах.
В основном стандарты ЕСПД содержат требования к составу, содержанию и оформлению документов, описывающих программу на разных стадиях ее жизненного цикла. Кроме того, несколько документов посвящено порядку хранения и обновления документации.
Стандарты ЕСПД практически лишены методической составляющей. Они не объясняют разработчику, как надо писать документацию, чтобы она получилась полезной, понятной, информативной, удобной и т. д. Они дают только перечень типов документов и список разделов первого уровня для каждого из них. Правда, о каждом разделе сказано, какие сведения должны быть в нем изложены.
Стандарты ЕСПД были приняты в конце 70-х годов и дошли до нас в виде, близком к первоначальному. В них отражена практика работы ведомственных вычислительных центров, где эксплуатировались большие ЭВМ. Взаимодействие человека с компьютерной системой тогда было построено совсем не так, как теперь, и осуществлялось через громоздкие пульты, перфокарты и распечатки, а для «простых смертных», решающих прикладные задачи, еще и при посредничестве квалифицированного персонала. Надо ли долго объяснять, насколько эти стандарты к настоящему времени устарели? Достаточно сказать, что им неведомы такие распространенные сегодня документы, как руководство пользователя и руководство администратора .
И все-таки ими продолжают активно пользоваться. Формально «девятнадцатому» есть современная альтернатива. Переведены на русский язык и приняты в России на правах национальных некоторые стандарты ИСО/МЭК в области системной и программной инженерии . Но крупные, в том числе, государственные заказчики переходить на них не торопятся. Это можно объяснить их косностью (или верностью традиции, как вам больше нравится), но лишь отчасти.
Дело в том, каждый стандарт ЕСПД при небольшом (страницы три максимум) объеме представляет собой набор довольно формальных и поэтому легко проверяемых требований к документу или к комплекту документации. Строго говоря, это не мешает разработчику документации писать правильно оформленные глупости. Но поскольку ЕСПД четко определяет, из чего должен состоять и как должен выглядеть результат, мы можем, по крайней мере, сразу отклонить пачку бумаги, которая в эти рамки не вписывается. Что существенно упрощает задачу сдачи-приемки документации как для заказчика, так и для исполнителя.
Стандарты ИСО/МЭК, напротив, содержат много разумных правил содержательного характера, но сложно представить себе процедуру их формальной проверки. Впрочем, никто не мешает применять оба ряда стандартов одновременно, благо, они касаются разных аспектов документирования и друг другу практически не противоречат.
Состав нормативно-технических документов
Обозначение | Наименование |
ГОСТ 19.001-77 | Общие положения |
ГОСТ 19.002-80 | Единая система программной документации. Схемы алгоритмов и программ. Правила выполнения |
ГОСТ 19.004-80 | Единая система программной документации. Термины и определения |
ГОСТ 19.005-85 | Единая система программной документации. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения |
ГОСТ 19.101-77 | Единая система программной документации. Виды программ и программных документов |
ГОСТ 19.102-77 | Единая система программной документации. Стадии разработки |
ГОСТ 19.103-77 | Единая система программной документации. Обозначение программ и программных документов |
ГОСТ 19.104-78 | Единая система программной документации. Основные надписи |
ГОСТ 19 105-78 | Единая система программной документации. Общие требования к программным документам |
ГОСТ 19.106-78 | Единая система программной документации. Требования к программным документам, выполненным печатным способом |
ГОСТ 19.201-78 | Единая система программной документации. Техническое задание |
ГОСТ 19.202-78 | Единая система программной документации. Спецификация. Требования к содержанию и оформлению |
ГОСТ 19.301-79 | Единая система программной документации. Программа и методика испытаний. Требования к содержанию и оформлению |
ГОСТ 19.401-78 | Единая система программной документации. Текст программы. Требования к содержанию и оформлению |
ГОСТ 19.402-78 | Единая система программной документации. Описание программы |
ГОСТ 19 403-79 | Единая система программной документации. Ведомость держателей подлинников |
ГОСТ 19.404-79 | Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению |
ГОСТ 19.501-78 | Единая система программной документации. Формуляр. Требования к содержанию и оформлению |
ГОСТ 19.502-78 | Единая система программной документации. Описание применения . Требования к содержанию и оформлению |
ГОСТ 19.503-79 | Единая система программной документации. Руководство системного программиста . Требования к содержанию и оформлению |
ГОСТ 19.504-79 | Единая система программной документации. Руководство программиста |
ГОСТ 19.505-79 | Единая система программной документации. Руководство оператора . Требования к содержанию и оформлению |
ГОСТ 19.506-79 | Единая система программной документации. Описание языка . Требования к содержанию и оформлению |
ГОСТ 19.507-79 | Единая система программной документации. Ведомость эксплуатационных документов |
ГОСТ 19.508-79 | Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению |
ГОСТ 19.601-78 | Единая система программной документации. Общие правила дублирования, учета и хранения |
ГОСТ 19.602-78 | Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом |
ГОСТ 19.603-78 | Единая система программной документации. Общие правила внесения изменений |
ГОСТ 19.604-78 | Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом |