Документирование программных изделий ЕСПД


Общие требования к оформлению


При выполнении программного документа машинописным или машинным способом документ выполняется на одной стороне листа, с такими интервалы между строк, которые обеспечивают пригодность к микрофильмированию
При выполнении типографским способом документ выполняется в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом
При выполнении части рукописным способом - на одной стороне листа, черными чернилами или тушью, чертежным шрифтом с высотой букв не менее 2,5 мм.
При выполнении программного документа машинописным, машинным или рукописным способами разрешается вписывать в документы отдельные слова, формулы, условные знаки и т.п., а также исправлять опечатки и графические неточности от руки чертежным шрифтом.

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

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

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

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

Форма 1

или по форме 2

Форма 2

где:
  • Поле 1 - порядковый номер страницы.
  • Поле 2 - обозначение документа.
  • Поле 3 - текст документа.
  • Поле 4 - строка изменений.

Рамку формата можно не наносить.

Аннотацию размещают на отдельной пронумерованной странице с заголовком "АННОТАЦИЯ", но не нумеруют как раздел. В аннотации указывают издание программы, кратко излагают назначение и содержание документа, общее количество частей документа (если их больше одной).

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


Начало  Назад  Вперед



Книжный магазин