Правила оформления курсовых и дипломных. Опыт применения еспд Виды программных документов

Правила оформления программной документации

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

Программная документация является неотъемлемым компонентом программного продукта и должна оформляться в соответствии с Единой системой программной документации (ЕСПД — ГОСТ серии 19). В рамках учебных работ допускается заключать всю содержательную часть программной документации в единый «отчёт по программе», при этом формальные требования к оформлению такого отчёта соответствуют требованиям к отчёту по НИР. В данном разделе изложены ключевые моменты государственных стандартов ЕСПД.

Программная документация, кроме формальных документов (спецификация, ведомость держателей подлинников, формуляр и др.), включает:

техническое задание (назначение, область применения программы, требования, предъявляемые к программе);
текст программы (запись программы с необходимыми комментариями);
описание программы (сведения о логической структуре и функционировании программы);
пояснительная записка (схема алгоритма, общее описание алгоритма и/или функционирования программы, обоснование принятых решений);
эксплуатационные документы.

Программный документ «Пояснительная записка» составляется на стадии эскизного или технического проектов программы. Как правило, на стадии рабочего проекта не используется.

К эксплуатационным документам относят:

описание применения (сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств);
руководство системного программиста (сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения);
руководство программиста (сведения для эксплуатации программы);
руководство оператора (сведения для обеспечения общения оператора с вычислительной системой в процессе выполнения программы);
описание языка (описание синтаксиса и семантики языка);
руководство по техническому обслуживанию (сведения для применения тестовых и диагностических программ при обслуживании технических средств)

Эксплуатационный документ «Описание языка» включается в программную документацию, если разработанный программный продукт реализует некий язык программирования, управления заданиями, организации вычислительного процесса и т. п.

Эксплуатационный документ «Руководство по техническому обслуживанию» включается в программную документацию, если разработанный программный продукт требует использования тестовых или диагностических программ.

В техническое задание включают:

введение (наименование, краткая характеристика области применения программы);
основания для разработки (документы, на основании которых ведётся разработка, организация, утвердившая документы, дата утверждения, наименование и обозначение темы разработки);
назначение разработки (функциональное и эксплуатационное назначение программы);
требования к программе и программной документации;
технико-экономические показатели;
стадии и этапы разработки;
порядок контроля и приёмки.

Наиболее существенной частью технического задания является раздел «требования. » В этом разделе приводятся:

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

Данный раздел может содержать требования к маркировке, упаковке, транспортировке и хранению, а также условия эксплуатации.

Кроме явно описанных в техническом задании требований, следует придерживаться общепринятых правил разработки программ с учётом выбранной парадигмы программирования:

Программа не должна содержать избыточные элементы (все элементы программы адекватны поставленной задаче: нет циклов, массивов и т. п. элементов, без которых можно обойтись).
Алгоритм должен быть структурирован: для функционального стиля программирования — адекватное разбиение на функции (процедуры), для объектно-ориентированного — адекватная иерархия классов. Каждая функция (метод класса) должна реализовывать ровно одно действие.
У функций (методов классов) должны быть параметры. Следует избегать использования в функциях глобальных переменных.
Программа должна аккуратно использовать память: работать с динамическими массивами, в ней не должно быть неиспользуемых блоков памяти, лишних переменных.
Должны проверятся диапазоны вводимых пользователем значений и параметров, передаваемых между модулями программы.
При использовании в программе каких-либо готовых компонент (библиотечных функций, классов) если функция или метод класса может завершиться неудачей, необходимо обязательно проверять это, не полагаясь на незначительность вероятности такого события.
Программа должна быть конфигурируема (важные параметры программы следует выделить в единый блок).

Текст программы представляет собой символическую запись на исходном или промежуточном языке или символическое представление машинных кодов. Текст программы оформляется моноширинным шрифтом (Courier, Lucida Console и т. п.) в соответствии с общепринятыми нормами оформления:

Количество операторов на строчке должно быть равно 1.
Все операторы, входящие в составной оператор, должны быть сдвинуты вправо на одинаковое количество позиций, при этом операторные скобки (т. е. то, что ограничивает составной оператор), относящиеся к одному блоку, должны располагаться следующим образом: открывающая скобка должна находиться на той же строчке, что и оператор, открывающий блок, а закрывающая должна находиться в той же колонке, с которой начинается оператор, открывающий блок. Допускается располагать открывающую скобку на строке, следующей за оператором, открывающим блок, в той же колонке, с которой начинается этот оператор.
Строка исходного текста программы должна целиком располагаться в одной типографской строке (до 80 символов в зависимости от шрифта). Несоблюдение этого правила говорит о слишком большой вложенности блоков, что означает неудачный алгоритм или структуру программы. В таком случае рекомендуется переосмыслить структуру программы, ввести дополнительные функции, заменив какие-то большие части кода их вызовами, переделать алгоритм и т.п.
Если синтаксис языка позволяет, желательно отделять знаки операций пробелами от операндов. Как и в обычном тексте, после запятых должен следовать пробел.
Определения функций или логические части программы следует отделять друг от друга пустыми строками.
Идентификаторы (названия переменных, типов, подпрограмм) должны быть значимыми настолько, чтобы читающий текст программы мог понимать их смысл без присутствия рядом автора. При необходимости объявление переменной или типа может сопровождаться комментарием.
Текст программы должен содержать комментарии, отражающие функциональное назначение того или иного блока программы, структуру программы.

Документ «Описание программы» содержит:

общие сведения (обозначение наименование программы, программное обеспечение, необходимое для функционирования программы, языки программирования, на которых написана программа);
функциональное назначение (классы решаемых задач, сведения о функциональных ограничениях на применение);
описание логической структуры (алгоритм программы, используемые методы, структура программы с описанием составных частей и связи между ними);
используемые технические средства (типы ЭВМ и устройств, которые используются при работе программы);
вызов и загрузка (способ вызова программы с соответствующего носителя данных);
входные данные (характер, организация и предварительная подготовка входных данных, а также их формат, описание и способ кодирования);
выходные данные (характер и организация выходных данных, а также их формат, описание и способ кодирования).

Описание логической структуры программы следует сопровождать блок-схемой программы.

Документ «Описание программы» может содержать также схемы данных, схемы взаимодействия программ, схемы ресурсов системы и проч., оформленные в соответствии с ГОСТ 19.701-90.

Документ «Описание применения» относится к эксплуатационным документам и состоит из следующих разделов:

назначение программы (возможности, основные характеристики, ограничения области применения);
условия применения (требования к техническим и программным средствам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера);
описание задачи (указываются определения задачи и методы её решения);
входные и выходные данные.

Руководство системного программиста

Документ «Руководство системного программиста» относится к эксплуатационным документам и включается в программную документацию, если разработанный программный продукт требует обслуживания системным программистом. Документ состоит из следующих разделов:

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

Документ «Руководство программиста» относится к эксплуатационным документам и включается в программную документацию, если разработанный программный продукт требует обслуживания программистом. Документ состоит из следующих разделов:

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

Документ «Руководство оператора» относится к эксплуатационным документам и состоит из следующих разделов:

назначение программы (информация, достаточная для понимания функций программы и её эксплуатации);
условия выполнения программы (минимальный и/или максимальный набор технических и программных средств и т. п.);
выполнение программы (последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы; описываются функции, форматы и возможные варианты команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды);
сообщения оператору (тексты сообщений, выдаваемых оператору в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям).

По данному ГОСТу, :

Титульная часть.
Информационная часть.

Основная часть.
Часть регистрации изменений.

А.В.ХХХХХ-ХХ ХХ ХХ-Х

Титульная часть:
Информационная часть:
- аннотация;
- лист содержания;
Основная часть:
- приложения;
- часть регистрации изменений:
- лист регистрации изменений.

Правила оформления программной документации

Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.

Виды программных документов и их содержание

На верх
ГОСТ 19.103-77 (Обозначение программ и программных документов)
Из данного ГОСТа мы получаем структуру обозначения программ и программных документов. Ниже приведены наиболее важные разделы.

Структура обозначения программ и ее программного документа — спецификации:

Настоящий стандарт устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способов их выполнения.

Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
Программный документ состоит из следующих условных частей:
- титульной;
- информационной;
- основной;
- регистрации изменений.
Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 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 см, проведённой в левой части страницы.
Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
- Одно примечание не нумеруется. После слова «Примечание» ставят точку.
- Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.

На верх
==================================
ГОСТ 19.604-78* (Правила внесения изменений в программные документы, выполненные
печатным способом)
Из данного ГОСТа мы получаем общие правила внесения изменений в программные документы (в итоге, для создания проекта, нам понадобится только лист регистрации изменений).

Настоящий стандарт устанавливает правила внесения изменений в программные документы, предусмотренные стандартами Единой системы программной документации (ЕСПД) и выполненные печатным способом.

Из за значительного объема информации в данном ГОСТе и для экономии места на данной странице рекомендую самостоятельно просмотреть ГОСТ 19.604-78* . Готовый пример оформления «листа регистрации изменений» Вы можете просмотреть в любом программном документе, предоставленном в разделе СКАЧАТЬ

Оформление программы по ГОСТу (how to)

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

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

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

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

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

Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 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 год) шаблоны.

Это интересно:

Приказ 109/ГС Об утверждении свода правил "СНиП 3.03.01-87 "Несущие и ограждающие конструкции" Купить Приказ 109/ГС - официальный бумажный документ с голограммой и синими печатями. подробнее Цена на этот документ пока неизвестна. Нажмите кнопку "Купить" и сделайте заказ, и мы пришлем […]
1С:Предприятие 8 Типовая конфигурацияБухгалтерия для Казахстана (базовая), редакция 2.0 Версия 2.0.13 Новое в версии 2.0.13.5 Обновление регламентированных показателей на 01 января 2014 года В соответствии с Законом РК "О республиканском бюджете на 2014-2016 годы" с 1 января 2014 […]
Нотариус Ипполитова Нина Александровна в Одинцово Отзывы о нотариусе Ипполитова Нина Александровна Настоящим свободно, своей волей и в своем интересе даю согласие ООО «Медиа-решения», находящемуся по адресу г. Тюмень ул. 50 лет ВЛКСМ 19 - 76 (далее – Оператор) на автоматизированную и […]
20 Нотариусов в Новороссийске Настоящим свободно, своей волей и в своем интересе даю согласие ООО «Медиа-решения», находящемуся по адресу г. Тюмень ул. 50 лет ВЛКСМ 19 - 76 (далее – Оператор) на автоматизированную и неавтоматизированную обработку своих персональных данных в соответствии […]
13 Нотариусов в Набережных Челнах Настоящим свободно, своей волей и в своем интересе даю согласие ООО «Медиа-решения», находящемуся по адресу г. Тюмень ул. 50 лет ВЛКСМ 19 - 76 (далее – Оператор) на автоматизированную и неавтоматизированную обработку своих персональных данных в […]
Сын прокурора Бледной зарей озарился, Тот старый кладбищенский двор, А над сырою могилой, Плакал молоденький вор. А над сырою могилой, Плакал молоденький вор. Бедная ты моя мама, Зачем ты так рано ушла, Жизни своей не видала, Отца – подлеца ты нашла. Жизни своей не […]
Неустойка зачетная Автострахование Жилищные споры Земельные споры Административное право Участие в долевом строительстве Семейные споры Гражданское право, ГК РФ Защита прав потребителей Трудовые споры, пенсии Главная Виды неустойки: зачетная, […]
Приказ (распоряжение) о поощрении работников Приказ о поощрении (премировании или награждении) работников издается руководителем организации, а распоряжение - другими уполномоченными на то должностными лицами. Руководитель организации также вправе ходатайствовать о поощрении работника […]

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Единая система программной документации	ГОСТ 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)

Наименование:

Единая система программной документации.

Действует

Дата введения:

Дата отмены:

Заменен на:

Текст ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов

ГОСТ 19.101-77

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

Издание официальное

Стандартинформ

УДК 002:651.7/.78:006.354

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

Unified system for program documentation.

Types of programs and program documents

Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 дата введения установлена

Стандарт полностью соответствует СТ СЭВ 1626-79.

(Измененная редакция, Изм. № 1).

1. ВИДЫ ПРОГРАММ

1.2. Программы подразделяют на виды, приведенные в табл. 1.

1.2, 1.3. (Измененная редакция, Изм. № 1).

2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

2.2. Виды программных документов и их содержание приведены в табл. 2.

Издание официальное ★

Перепечатка воспрещена

) Издательство стандартов, 1977 © СТАНДАРТИНФОРМ, 2010

Издание (январь 2010 г.) с Изменением № 1, утвержденным в июне 1981 г. (ИУС 9-81).

Таблица 2

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

2.3. Виды эксплуатационных документов и их содержание приведены в табл. 3.

Таблица 3

эксплуатационного документа

Ведомость эксплуатационных документов Формуляр

Описание применения

Руководство программиста Руководство оператора

Описание языка Руководство по техническому обслуживанию

Перечень эксплуатационных документов на программу

Основные характеристики программы, комплектность и сведения об эксплуатации программы

Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств

Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения

Сведения для эксплуатации программы

Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание синтаксиса и семантики языка

Сведения для применения тестовых и диагностических программ при обслуживании технических средств

2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл. 4.

Таблица 4

Код вида документа	Вид документа	Стадии разработки
		Эскизный	Технический	Рабочий проект
		Эскизный	Технический	компонент	комплекс
	Спецификация
	Ведомость держателей подлин-

	Текст программы
	Описание программы
	Ведомость эксплуатационных
	документов
	Формуляр

Продолжение таблицы 4

Код вида документа			Стадии разработки
Код вида документа	Вид документа	Эскизный	Технический	Рабочий проект
				компонент	комплекс
	Описание применения
	Руководство системного программиста
	Руководство программиста
	Руководство оператора
	Описание языка
	Руководство по техническому обслуживанию
	Программа и методика испытаний
	Пояснительная записка
	Прочие документы

Условные обозначения:

Документ обязательный;

С - документ обязательный для компонентов, имеющих самостоятельное применение;

О - необходимость составления документа определяется на этапе разработки и утверждения технического задания;

Документ не составляют.

2.2-2.5. (Измененная редакция, Изм. № 1).

Технические условия разрабатывают на стадии «Рабочий проект».

(Введен дополнительно, Изм. № 1).

ГОСТ 19.001-77 Единая система программной документации. Общие положения
ГОСТ 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 Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом
ГОСТ 28195-89 Оценка качества программных средств. Общие положения
ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания
ГОСТ 34.602-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы
ГОСТ Р 56447-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для обработки и интерпретации данных сейсморазведки. Основные функциональные и технические требования
ГОСТ Р 56448-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для геологического моделирования месторождений. Основные функциональные и технические требования
ГОСТ Р 56450-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования систем сбора и подготовки углеводородов. Основные функциональные и технические требования
ГОСТ Р 55711-2013 Комплекс технических средств автоматизированной адаптивной ВЧ (КВ) дуплексной радиосвязи. Алгоритмы работы
ГОСТ Р 56566-2015 Информационные технологии. Оценка процессов. Часть 9. Профили целевого процесса
ГОСТ Р 55692-2013 Модули электронные. Методы составления и отладки тест-программ для автоматизированного контроля
ГОСТ Р 56449-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования месторождений. Основные функциональные и технические требования
ГОСТ Р 56413-2015 Информационные технологии. Европейские профили профессий ИКТ-сектора
ГОСТ Р ИСО/МЭК 15026-1-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 1. Понятия и словарь
ГОСТ Р ИСО/МЭК 15026-4-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 4. Гарантии жизненного цикла
ГОСТ Р 56920-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 1. Понятия и определения
ГОСТ Р 56921-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 2. Процессы тестирования
ГОСТ Р ИСО/МЭК 26555-2016 Системная и программная инженерия. Инструменты и методы технического менеджмента линейки продуктов
ГОСТ Р ИСО/МЭК 29155-1-2016 Системная и программная инженерия. Структура сопоставительного анализа эффективности выполнения проектов информационных технологий. Часть 1. Понятия и определения
ГОСТ Р 54360-2011 Лабораторные информационные менеджмент-системы (ЛИМС). Стандартное руководство по валидации ЛИМС
ГОСТ Р 54593-2011 Информационные технологии. Свободное программное обеспечение. Общие положения
ГОСТ Р ИСО/МЭК 12207-2010 Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств
ГОСТ Р 53798-2010 Стандартное руководство по лабораторным информационным менеджмент-системам (ЛИМС)
ГОСТ Р ИСО/МЭК 15504-1-2009 Информационные технологии. Оценка процессов. Часть 1. Концепция и словарь
ГОСТ Р ИСО/МЭК 15504-2-2009 Информационная технология. Оценка процесса. Часть 2. Проведение оценки
ГОСТ Р ИСО/МЭК 15504-3-2009 Информационная технология. Оценка процесса. Часть 3. Руководство по проведению оценки
ГОСТ Р 57098-2016 Системная и программная инженерия. Управление жизненным циклом. Руководство для описания процесса
ГОСТ Р 57100-2016 Системная и программная инженерия. Описание архитектуры
ГОСТ Р 57101-2016 Системная и программная инженерия. Процессы жизненного цикла. Управление проектом
ГОСТ Р 57102-2016 Информационные технологии. Системная и программная инженерия. Управление жизненным циклом. Часть 2. Руководство по применению ИСО/МЭК 15288
ГОСТ Р 57122-2016 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для проектирования строительства скважин. Основные функциональные и технические требования
ГОСТ Р 57193-2016 Системная и программная инженерия. Процессы жизненного цикла систем
ГОСТ Р ИСО/МЭК 15504-5-2016 Информационные технологии. Оценка процессов. Часть 5. Образец модели оценки процессов жизненного цикла программного обеспечения
ГОСТ 34009-2016 Средства и системы управления железнодорожным тяговым подвижным составом. Требования к программному обеспечению
ГОСТ Р 57318-2016 Системы промышленной автоматизации и интеграция. Применение и управление процессами системной инженерии
ГОСТ Р ИСО/МЭК 25001-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Планирование и управление
ГОСТ Р ИСО/МЭК 33004-2017 Информационные технологии. Оценка процесса. Требования к эталонным моделям процесса, моделям оценки процесса и моделям зрелости
ГОСТ Р ИСО/МЭК 15414-2017 Информационные технологии. Открытая распределенная обработка. Эталонная модель. Язык описания предприятия
ГОСТ IEC 60848-2016 Язык спецификаций GRAFCET для последовательных функциональных схем
ГОСТ Р ИСО/МЭК 25051-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Требования к качеству готового к использованию программного продукта (RUSP) и инструкции по тестированию
ГОСТ Р ИСО/МЭК 33001-2017 Информационные технологии. Оценка процесса. Понятия и терминология
ГОСТ Р ИСО/МЭК 33002-2017 Информационные технологии. Оценка процесса. Требования к проведению оценки процесса
ГОСТ Р ИСО/МЭК 33003-2017 Информационные технологии. Оценка процесса. Требования к системам измерения процесса
ГОСТ Р ИСО/МЭК 33020-2017 Информационные технологии. Оценка процесса. Система измерения процесса для оценки возможностей процесса
ГОСТ Р 57640-2017 Информационные технологии. Эталонная модель процесса (ЭМП) для управления информационной безопасностью
ГОСТ Р ИСО/МЭК 30121-2017 Информационные технологии. Концепция управления рисками, связанными с проведением судебной экспертизы свидетельств, представленных в цифровой форме
ГОСТ Р 58041-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Система стандартов по программному обеспечению для решения задач поиска, разведки и разработки месторождений. Основные положения и технические требования
ГОСТ Р 58042-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Основные требования к исходным данным программных комплексов для решения задач поиска, разведки и разработки месторождений
ГОСТ Р ИСО/МЭК 10746-1-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 1. Основные положения
ГОСТ Р ИСО/МЭК 10746-4-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 4. Архитектурная семантика
ГОСТ Р ИСО/МЭК 12119-2000 Информационная технология. Пакеты программ. Требования к качеству и тестирование
ГОСТ Р ИСО/МЭК 12207-99 Информационная технология. Процессы жизненного цикла программных средств
ГОСТ Р ИСО/МЭК 14764-2002 Информационная технология. Сопровождение программных средств

На верх

ГОСТ 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 см, проведённой в левой части страницы.

Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.

Одно примечание не нумеруется. После слова «Примечание» ставят точку.
Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.

Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами. (в итоге, для создания проекта, нам понадобится только лист регистрации изменений).
- Настоящий стандарт устанавливает правила внесения изменений в программные документы, предусмотренные стандартами Единой системы программной документации (ЕСПД) и выполненные печатным способом.
Из за значительного объема информации в данном ГОСТе и для экономии места на данной странице рекомендую самостоятельно просмотреть ГОСТ 19.604-78* . Готовый пример оформления "листа регистрации изменений" Вы можете просмотреть в любом программном документе, предоставленном в разделе СКАЧАТЬ

На верх
==================================

Программная документация является неотъемлемым компонентом программного продукта и должна оформляться в соответствии с Единой системой программной документации (ЕСПД - ГОСТ серии 19). В рамках учебных работ допускается заключать всю содержательную часть программной документации в единый «отчёт по программе», при этом формальные требования к оформлению такого отчёта соответствуют требованиям к отчёту по НИР. Программная документация, кроме формальных документов (спецификация, ведомость держателей подлинников, формуляр и др.), включает:

· Техническое задание (назначение, область применения программы, требования, предъявляемые к программе).
· Текст программы (запись программы с необходимыми комментариями).
· Описание программы (сведения о логической структуре и функционировании программы).
· Пояснительная записка (схема алгоритма, общее описание алгоритма и/или функционирования программы, обоснование принятых решений).
· Эксплуатационные документы.

К эксплуатационным документам относят:

· Описание применения (сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств).
· Руководство системного программиста (сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения).
· Руководство программиста (сведения для эксплуатации программы).
· Руководство оператора (сведения для обеспечения общения оператора с вычислительной системой в процессе выполнения программы).
· Описание языка (описание синтаксиса и семантики языка).
· Руководство по техническому обслуживанию (сведения для применения тестовых и диагностических программ при обслуживании технических средств).

Основная часть программной документации составляется на стадии рабочего проекта. Необходимость того или иного документа определяется на этапе составления технического задания. Допускается объединять отдельные виды документов. Эксплуатационный документ «Описание языка» включается в программную документацию, если разработанный программный продукт реализует некий язык программирования, управления заданиями, организации вычислительного процесса и т. П. Эксплуатационный документ «Руководство по техническому обслуживанию» включается в программную документацию, если разработанный программный продукт требует использования тестовых или диагностических программ.

Текст программы представляет собой символическую запись на исходном или промежуточном языке или символическое представление машинных кодов. Текст программы оформляется моноширинным шрифтом (Courier, Lucida Console и т. П.) в соответствии с общепринятыми нормами оформления :

1. Количество операторов на строчке должно быть равно 1.
2. Все операторы, входящие в составной оператор, должны быть сдвинуты вправо на одинаковое количество позиций, при этом операторные скобки (т. Е. то, что ограничивает составной оператор), относящиеся к одному блоку, должны располагаться следующим образом: открывающая скобка должна находиться на той же строчке, что и оператор, открывающий блок, а закрывающая должна находиться в той же колонке, с которой начинается оператор, открывающий блок. Допускается располагать открывающую скобку на строке, следующей за оператором, открывающим блок, в той же колонке, с которой начинается этот оператор.
3. Строка исходного текста программы должна целиком располагаться в одной типографской строке (до 80 символов в зависимости от шрифта). Несоблюдение этого правила говорит о слишком большой вложенности блоков, что означает неудачный алгоритм или структуру программы. В таком случае рекомендуется переосмыслить структуру программы, ввести дополнительные функции, заменив какие-то большие части кода их вызовами, переделать алгоритм и т.п.
4. Если синтаксис языка позволяет, желательно отделять знаки операций пробелами от операндов. Как и в обычном тексте, после запятых должен следовать пробел.
5. Определения функций или логические части программы следует отделять друг от друга пустыми строками.
6. Идентификаторы (названия переменных, типов, подпрограмм) должны быть значимыми настолько, чтобы читающий текст программы мог понимать их смысл без присутствия рядом автора. При необходимости объявление переменной или типа может сопровождаться комментарием.
7. Текст программы должен содержать комментарии, отражающие функциональное назначение того или иного блока программы, структуру программы.

Документ Описание программы содержит:

· Общие сведения (обозначение наименование программы, программное обеспечение, необходимое для функционирования программы, языки программирования, на которых написана программа);
· Функциональное назначение (классы решаемых задач, сведения о функциональных ограничениях на применение);
· Описание логической структуры (алгоритм программы, используемые методы, структура программы с описанием составных частей и связи между ними);
· Используемые технические средства (типы ЭВМ и устройств, которые используются при работе программы);
· Вызов и загрузка (способ вызова программы с соответствующего носителя данных);
· Входные данные (характер, организация и предварительная подготовка входных данных, а также их формат, описание и способ кодирования);
· Выходные данные (характер и организация выходных данных, а также их формат, описание и способ кодирования).

Описание логической структуры программы следует сопровождать блок-схемой программы. Документ «Описание программы» может содержать также схемы данных, схемы взаимодействия программ, схемы ресурсов системы и проч., оформленные в соответствии с ГОСТ 19.701-90 .

Документ Описание применения относится к эксплуатационным документам и состоит из следующих разделов:

· Назначение программы (возможности, основные характеристики, ограничения области применения).
· Условия применения (требования к техническим и программным средствам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера).
· Описание задачи (указываются определения задачи и методы её решения).
· Входные и выходные данные.

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

· Общие сведения о программе (назначение и функции программы, сведения о технических и программных средствах, обеспечивающих выполнение данной программы).
· Структура программы (сведения о структуре, взаимосвязи между модулями программы и с другими программами).
* Настройка программы (настройка на состав технических средств, выбор функций)/
* Проверка программы (способы и методики проверки, контрольные примеры, методы прогона, результаты).
* Дополнительные возможности.
* Сообщения системному программисту (тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям).

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

* Назначение и условия применения программы (назначение и функции программы, сведения о технических и программных средствах, обеспечивающих выполнение данной программы).
* Характеристики программы (временные характеристики, режимы работы, средства контроля правильности выполнения и т. П.).
* Обращение к программе (способы передачи управления и параметров данных).
* Входные и выходные данные (формат и кодирование).
* Сообщения (тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям).

Документ Руководство оператора относится к эксплуатационным документам и состоит из следующих разделов:

* Назначение программы (информация, достаточная для понимания функций программы и её эксплуатации);
* Условия выполнения программы (минимальный и/или максимальный набор технических и программных средств и т. П.);
* Выполнение программы (последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы; описываются функции, форматы и возможные варианты команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды);
* Сообщения оператору (тексты сообщений, выдаваемых оператору в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям).

При оформлении текстовых и графических материалов, входящих в программную документацию следует придерживаться действующих стандартов. Некоторые положения этих стандартов приведены ниже. Оформление текстового и графического материала. Текстовые документы оформляют на листах формата А4, причем графический материал допускается представлять на листах формата A3. Поля на листе определяют в соответствии с общими требованиями: левое - не менее 30, правое - не менее 10, верхнее - не менее 15, а нижнее - не менее 20 мм . В текстовых редакторах для оформления записки параметры страницы заказывают в зависимости от устройства печати. При ручном оформлении документов параметры страницы выбирают из соображений удобства. Нумерация всех страниц - сквозная. Номер проставляется сверху справа арабской цифрой. Страницами считают, как листы с текстами и рисунками, так и листы приложений. Первой страницей считается титульный лист. Номер страницы на титульном листе не проставляют. Наименование разделов пишут прописными буквами в середине строки. Расстояние между заголовками и текстом, а также между заголовками раздела и подразделов должно быть равно:

* При выполнении документа машинописным способом - двум интервалам.
* При выполнении рукописным способом - 10 мм.

Наименования подразделов и пунктов следует размещать с абзацного отступа и печатать вразрядку с прописной буквы, не подчеркивая и без точки в конце. Расстояние между последней строкой текста предыдущего раздела и последующим заголовком при расположении их на одной странице должно быть равно:

* При выполнении документа машинописным способом - трем интервалам.
* При выполнении рукописным способом - не менее 15 мм.
* При использовании текстовых редакторов - определяется возможностями редактора.

Разделы и подразделы нумеруются арабскими цифрами с точкой. Разделы должны иметь порядковые номера 1, 2, и т. Д. Номер подраздела включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номер раздела или пункта, например, «в разд. 4», «в п. 3.3.4». Текст разделов печатают через 1,5-2 интервала. При использовании текстовых редакторов высота букв и цифр должна быть не менее 1,8 мм (шрифты № 11-12). Перечисления следует нумеровать арабскими цифрами со скобкой, например: 2), 3) и т. Д. - с абзацного отступа. Допускается выделять перечисление простановкой дефиса перед пунктом текста или символом, его заменяющим, в текстовых редакторах. Оформление рисунков, схем алгоритмов, таблиц и формул. В соответствии с ГОСТ 2.105-79 «Общие требования к текстовым документам» иллюстрации (графики, схемы, диаграммы) могут быть приведены как в основном тексте, так и в приложении. Все иллюстрации именуют рисунками. Все рисунки, таблицы и формулы нумеруют арабскими цифрами последовательно (сквозная нумерация) или в пределах раздела (относительная нумерация). В приложении - в пределах приложения. Каждый рисунок должен иметь подрисуночную подпись - название, помещаемую под рисунком, например: Рис.12. Форма окна основного меню.

На все рисунки, таблицы и формулы в записке должны быть ссылки в виде: «(рис. 12)» или «форма окна основного меню приведена на рис. 12». Если позволяет место, рисунки и таблицы должны размещаться сразу после абзаца, в котором они упоминаются в первый раз, или как можно ближе к этому абзацу на следующих страницах. Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например: Рис. 12. Продолжение.

Рисунки следует размещать так, чтобы их можно было рассматривать без поворота страницы. Если такое размещение невозможно, рисунки следует располагать так, чтобы для просмотра надо было повернуть страницу по часовой стрелке. В этом случае верхним краем является левый край страницы. Расположение и размеры полей сохраняются.

Схемы алгоритмов должны быть выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при вычерчивании схем алгоритмов должна составлять от 0,6… 1,5 мм. Надписи на схемах должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть не менее 3,5 мм.

Номер таблицы размещают в правом верхнем углу или перед заголовком таблицы, если он есть. Заголовок, кроме первой буквы, выполняют строчными буквами. Ссылки на таблицы в тексте пояснительной записки указывают в виде слова «табл.» и номера таблицы. Например: Результаты тестов приведены в табл. 4.

Номер формулы ставится с правой стороны страницы в круглых скобках на уровне формулы. Например: z:=sin(x)+ln(y); (12)

Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» пропис-ными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. Д. Например: ПРИЛОЖЕНИЕ 2 Титульный лист расчетно-пояснительной записки.

Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П», Напри-мер: Рис. П. 12 - 12-й рисунок приложения; Рис. П1.2 - 2-й рисунок 1-го приложения.

Если в приложении приводится текст программы, то каждый файл оформляют как рисунок с наименованием файла и его назначением, например: Рис. П2.4. Файл menuran.pas - программа движения курсора основного меню.

Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т. д.) должны содержать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания. При наличии трех и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.». Издательство надо приводить полностью в именительном падеже: допускается сокращение названия только двух городов: Москва (М.) и Санкт-Петербург (СПб.).

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

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

Правила оформления курсовых и дипломных. Опыт применения еспд Виды программных документов

Правила оформления программной документации

Оформление программы по ГОСТу (how to)

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

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

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

Вид программного документа. ГОСТ 19.101 — 77