Оформление программы по ГОСТу (how to) — различия между версиями

Материал из SRNS
Перейти к: навигация, поиск
(→‎Примеры)
 
(не показаны 12 промежуточных версий 2 участников)
Строка 1: Строка 1:
−
Программы для ЭВМ оформляются в соответствие с требованиями Единой системы программной документации [http://ru.wikipedia.org/wiki/Единая_система_программной_документации (ЕСПД)]. ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов. <br />  
+
Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации [http://ru.wikipedia.org/wiki/Единая_система_программной_документации (ЕСПД)]. ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов. <br />  
 
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
 
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
  
  
 
== Краткий алгоритм оформления программы ==
 
== Краткий алгоритм оформления программы ==
−
Кратко алгоритм оформления программы изображен на рисунке. Более подробно процесс оформления описан далее.
+
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
−
[[File:20132009 Алгоритм оформления программы по ГОСТ.png|center|1000x1000px]]
+
[[File:20130920 Виды программных документов.png|center|350x350px]]
  
 +
 +
[[File:20132009 Алгоритм оформления программы по ГОСТ.png|center|750x750px]]
  
 
== Оформление программного документа ==
 
== Оформление программного документа ==
Строка 17: Строка 19:
 
[[Media:ГОСТ 19.105-78.pdf|ГОСТ 19.105-78]] устанавливает общие требования к оформлению программных документов.
 
[[Media:ГОСТ 19.105-78.pdf|ГОСТ 19.105-78]] устанавливает общие требования к оформлению программных документов.
  
−
По данному ГОСТу, программный документ должен состоять из следующих частей:
+
По данному ГОСТу, <u>программный документ должен состоять из следующих частей</u>:
 
*'''Титульная часть.''' Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа описаны [[Оформление_программы_по_ГОСТу_(how_to)#Основные надписи. ГОСТ 19.104 - 78|далее]].
 
*'''Титульная часть.''' Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа описаны [[Оформление_программы_по_ГОСТу_(how_to)#Основные надписи. ГОСТ 19.104 - 78|далее]].
 
*'''Информационная часть.''' Информационная часть должна состоять из аннотации и содержания.  
 
*'''Информационная часть.''' Информационная часть должна состоять из аннотации и содержания.  
Строка 24: Строка 26:
 
''Необходимость наличия информационной части в разных видах программных документов определяется соответствующими ГОСТами на эти программные документы.''
 
''Необходимость наличия информационной части в разных видах программных документов определяется соответствующими ГОСТами на эти программные документы.''
 
*'''Основная часть.''' Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
 
*'''Основная часть.''' Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
−
*'''Часть регистрации изменений''' В этой части делается запись о каждом изменеии программного документа в соответствии с требованиями ГОСТ 19.603 - 78.
+
*'''Часть регистрации изменений.''' В этой части делается запись о каждом изменении программного документа в соответствии с требованиями ГОСТ 19.603 - 78.
−
 
+
  
  
Строка 69: Строка 70:
  
 
В ГОСТе есть примеры титульного листа и листа утверждения, а также общая форма листа, разбитая на поля. Также можно посмотреть [[Media:20130920 GOST Example Текст Описание программы.doc|пример]].
 
В ГОСТе есть примеры титульного листа и листа утверждения, а также общая форма листа, разбитая на поля. Также можно посмотреть [[Media:20130920 GOST Example Текст Описание программы.doc|пример]].
 +
 +
 +
=== Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78 ===
 +
[[Media:ГОСТ 19.106-78.pdf|ГОСТ 19.106-78]] устанавливает правила выполнения программных документов для печатного способа выполнения.
 +
 +
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
 +
 +
Материалы программного документа <u>должны располагаться в следующей последовательности</u>:
 +
*Титульная часть:
 +
**лист утверждения (не входит в общее количество листов документа);
 +
**титульный лист (первый лист документа);
 +
*Информационная часть:
 +
**аннотация;
 +
**лист содержания;
 +
*Основная часть:
 +
**текст документа (с рисунками, таблицами и т.п.);
 +
**приложения;
 +
**перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
 +
**часть регистрации изменений:
 +
**лист регистрации изменений.
 +
 +
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.
 +
Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
 +
 +
 +
Форматирование текста:
 +
*Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
 +
*Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
 +
*Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
 +
*Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
 +
*Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
 +
*Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
 +
**при выполнении документа машинописным способом - двум интервалам.
 +
*Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
 +
**при выполнении документа машинописным способом - трём машинописным интервалам.
 +
*Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
 +
*В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
 +
*Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
 +
*При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
 +
*Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
 +
*Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
 +
*Необходимые пояснения к тексту документа могут оформляться сносками.
 +
*Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
 +
*Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
 +
*Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
 +
*Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
 +
*Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
 +
*В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
 +
*Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
 +
*В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
 +
*Одно примечание не нумеруется. После слова «Примечание» ставят точку.
 +
*Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
 +
*Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
 +
*Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
 +
*Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
 +
 +
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
 +
 +
== Примеры ==
 +
Мои наиболее актуальные (2016 год) [[Media:Шаблоны ЕСПД.rar|шаблоны]].
 +
 +
Примеры оформления взяты с [http://asutpseta.narod.ru/index.htm данного] сайта.
 +
*[[Media:20130920 GOST Example Текст Описание применения.doc|Описание применения]]
 +
*[[Media:20130920 GOST Example Текст Описание программы.doc|Описание программы]]
 +
*[[Media:20130920 GOST Example Текст программы.doc|Текст программы]]
 +
 +
 +
Имеющиеся ГОСТы:
 +
{| class="wikitable" border="1"
 +
|-allign = "center"
 +
!Обозначение
 +
!Название
 +
|-
 +
|[[Media:ГОСТ 19.101-77.pdf|ГОСТ 19.101-77]]||Виды программ и программных документов
 +
|-
 +
|[[Media:ГОСТ 19.103-77.pdf|ГОСТ 19.103-77]]||Обозначение программ и программных документов
 +
|-
 +
|[[Media:ГОСТ 19.104-78.pdf|ГОСТ 19.104-78]]||Основные надписи
 +
|-
 +
|[[Media:ГОСТ 19.105-78.pdf|ГОСТ 19.105-78]]||Общие требования к программным документам
 +
|-
 +
|[[Media:ГОСТ 19.106-78.pdf|ГОСТ 19.106-78]]||Требования к программным документам, выполненным печатным способом
 +
|-
 +
|[[Media:ГОСТ 19.401-78.pdf|ГОСТ 19.401-78]]||Текст программы
 +
|-
 +
|[[Media:ГОСТ 19.402-78.pdf|ГОСТ 19.402-78]]||Описание программы
 +
|-
 +
|[[Media:ГОСТ 19.502-78.pdf|ГОСТ 19.502-78]]||Описание применения
 +
|}
 +
 +
== Ссылки ==
 +
*[http://www.swrit.ru/gost-espd.html www.swrit.ru] - можно скачать ГОСТы в pdf
 +
*[http://ru.wikipedia.org/wiki/Единая_система_программной_документации ru.wikipedia.org]
 +
 +
 +
[[Категория:HOWTO]]

Текущая версия на 13:34, 22 сентября 2016

Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД). ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.


Содержание

[править] Краткий алгоритм оформления программы

Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.

Ошибка создания миниатюры: convert: unable to open image `/app/images/9/93/20130920___.png': No such file or directory @ error/blob.c/OpenBlob/2641.
convert: no images defined `/tmp/transform_2170a2634488-1.png' @ error/convert.c/ConvertImageCommand/3044.


Ошибка создания миниатюры: convert: unable to open image `/app/images/0/0a/20132009_____.png': No such file or directory @ error/blob.c/OpenBlob/2641.
convert: no images defined `/tmp/transform_1c5689b01314-1.png' @ error/convert.c/ConvertImageCommand/3044.

[править] Оформление программного документа

Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.

Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77, ГОСТ 19.103-77, ГОСТ 19.104-78, ГОСТ 19.105-78, ГОСТ 19.106-78, ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.


[править] Общие требования к программным документам. ГОСТ 19.105 - 78

ГОСТ 19.105-78 устанавливает общие требования к оформлению программных документов.

По данному ГОСТу, программный документ должен состоять из следующих частей:

  • Титульная часть. Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа описаны далее.
  • Информационная часть. Информационная часть должна состоять из аннотации и содержания.
    • В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
    • Содержание включает перечень записей о структурных элеметнах основной части документа.

Необходимость наличия информационной части в разных видах программных документов определяется соответствующими ГОСТами на эти программные документы.

  • Основная часть. Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
  • Часть регистрации изменений. В этой части делается запись о каждом изменении программного документа в соответствии с требованиями ГОСТ 19.603 - 78.


[править] Вид программного документа. ГОСТ 19.101 - 77

ГОСТ 19.101-77 устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения.

ГОСТ устанавливает 2 вида программ:

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

Также ГОСТ определяет виды и содержание программных документов.

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


[править] Обозначение программ и программных документов. ГОСТ 19.103 - 77

ГОСТ 19.103-77 устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

Проще говоря, данный ГОСТ описывает каким должен быть шифр документа вида А.В.ХХХХХ-ХХ ХХ ХХ-Х, и что означает каждое поле данного шифра.


[править] Основные надписи. ГОСТ 19.104 - 78

ГОСТ 19.104-78 устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способа их выполнения.

В ГОСТе есть примеры титульного листа и листа утверждения, а также общая форма листа, разбитая на поля. Также можно посмотреть пример.


[править] Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78

ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.

Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".

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

  • Титульная часть:
    • лист утверждения (не входит в общее количество листов документа);
    • титульный лист (первый лист документа);
  • Информационная часть:
    • аннотация;
    • лист содержания;
  • Основная часть:
    • текст документа (с рисунками, таблицами и т.п.);
    • приложения;
    • перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
    • часть регистрации изменений:
    • лист регистрации изменений.

В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.


Форматирование текста:

  • Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
  • Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
  • Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
  • Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
  • Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
  • Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
    • при выполнении документа машинописным способом - двум интервалам.
  • Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
    • при выполнении документа машинописным способом - трём машинописным интервалам.
  • Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
  • В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
  • Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
  • При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
  • Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
  • Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
  • Необходимые пояснения к тексту документа могут оформляться сносками.
  • Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
  • Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
  • Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
  • Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
  • Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
  • В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
  • Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
  • В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
  • Одно примечание не нумеруется. После слова «Примечание» ставят точку.
  • Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
  • Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
  • Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
  • Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.

В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.

[править] Примеры

Мои наиболее актуальные (2016 год) шаблоны.

Примеры оформления взяты с данного сайта.


Имеющиеся ГОСТы:

Обозначение Название
ГОСТ 19.101-77 Виды программ и программных документов
ГОСТ 19.103-77 Обозначение программ и программных документов
ГОСТ 19.104-78 Основные надписи
ГОСТ 19.105-78 Общие требования к программным документам
ГОСТ 19.106-78 Требования к программным документам, выполненным печатным способом
ГОСТ 19.401-78 Текст программы
ГОСТ 19.402-78 Описание программы
ГОСТ 19.502-78 Описание применения

[править] Ссылки

Источник — «https://srns.ru/index.php?title=Оформление_программы_по_ГОСТу_(how_to)&oldid=18616»
Персональные инструменты
Пространства имён

Варианты
Действия
SRNS Wiki
Рабочие журналы
Приватный файлсервер
QNAP Сервер
Инструменты