Требования к программным документам, содержащим в основном сплошной текст.

      Комментарии к записи Требования к программным документам, содержащим в основном сплошной текст. отключены

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

Единая система программной документации ГОСТ 19.106-78(СТ СЭВ 2088-80)
ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
United system for program documentation. requirement for printed documents.

Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен

с 01.01 1980 г.

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

Стандарт не распространяется на программный документ «Текст программы».

Стандарт соответствует СТ СЭВ 2088-80 в части установления структуры и требований к изложению программных документов (см. справочное приложение 1).

ОБЩИЕ ТРЕБОВАНИЯ

1.1. Состав и структура программного документа устанавливается по ГОСТ 19.105-78.

1.2. Программный документ выполняют одним из следующих печатных способов:

  • машинописным — на одной стороне листа, через два интервала; допускается через один или полтора интервала, если обеспечивается пригодность к микрофильмированию по ГОСТ 13.102-72 (разд.1);
  • машинным — на одной стороне листа, с расстояниями между основаниями строк, обеспечивающим пригодность к микрофильмированию;
  • типографским — в соответствии с требованиями, предъявленными к изданиям, изготавливаемым типографским способом.

Примечания:

1. При выполнении программного документа допускается сочетание печатных способов, указанных в п. 1.2. настоящего стандарта.

2. Допускается выполнение документа или его части рукописным способом — на одной стороне листа черными чернилами или тушью, основным чертёжным шрифтом по ГОСТ 2.304-68 с высотой букв не менее 2,5мм.

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

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

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

1.5. Программные документы оформляют:

  • на листах формата А4 (ГОСТ 2.301-68) — при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата А3 (форма 2);
  • на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных — при изготовлении документа машинным способом. Допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств;
  • на листах типографических форматов — при изготовлении документа типографским способом.

Форма 1.

Форма 2.

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

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

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

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

    1.7. Перечни терминов и сокращений, предметный указатель, перечень символов и числовых коэффициентов следует составлять в алфавитном порядке.

    Остальные перечни составляют в порядке возрастания номеров.

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

    ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, СОДЕРЖАЩИМ В ОСНОВНОМ СПЛОШНОЙ ТЕКСТ.

    Построение документа.

    2.1.1. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103-77.

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

    Допускается включать в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы.

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

    Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.

    Лист утверждения выпускают на весь документ с обозначением первой части.

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

    2.1.2. Информационная и основная части программного документа выполняются по форме 1 или 2, где:

    • поле 1 — порядковый номер страницы;
    • поле 2 — обозначение документа;
    • поле 3 — текст документа;
    • поле 4 — строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604-78.

    Рамку (границы) формата страниц документа допускается не наносить.

    2.1.3. Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.

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

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

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

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

    Статьи к прочтению:

    Компас 3D v16 Внешние ссылки


    Похожие статьи: