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


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


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

Ссылки

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

Таблицы

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

Примечания

В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова "Примечание" ставят точку. Несколько примечаний нумеруют по порядку арабскими цифрами с точкой. После слова "Примечания" ставят двоеточие.

Сокращения

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

Приложения

В виде приложений можно оформлять иллюстративный материал, таблицы или текст вспомогательного характера.Приложения могут быть продолжением данного документа на последующих страницах или выпускаться в виде отдельного документа. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ" прописными буквами и иметь тематический заголовок При наличии в документе более одного приложения все приложения нумеруют в арабскими цифрами (без знака ¦).
Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению. Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".

Оглавление




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