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


Общие требования к оформлению - часть 3


При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Ниже приведен пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов:

Текст документа

Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
Для выделения основных понятий допускается изменять интервалы между словами, а также печатать отдельные слова и части текста шрифтом, отличным от печати основного текста,
Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего образа шрифта, например, "печатающее устройство2)".

Иллюстрации

Иллюстрации могут быть расположены в тексте документа и/или в приложениях. Иллюстрации нумеруются арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах приложения.
Ссылки на иллюстрации дают по типу: "рис.2" или "(рис.2)". Ссылки на ранее упомянутые иллюстрации дают по типу: "см. рис.2".
Иллюстрации могут иметь наименование и подрисуночный текст, поясняющий содержание иллюстрации. Наименование помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющим текстом.

Формулы

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


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