Оформление программы по ГОСТу (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.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 устанавливает правила выполнения программных документов для печатного способа выполнения.

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

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

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

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

    • Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
    • Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
    • Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
    • Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
    • Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
    • Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
      • при выполнении документа машинописным способом - двум интервалам.
      • при выполнении документа машинописным способом - трём машинописным интервалам.

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

      📎📎📎📎📎📎📎📎📎📎