1 Основополагающие стандарты ЕСПД

Приложения [из подр. 2.9 ГОСТ 19.106-78]

Приложения [из подр. 2.9 ГОСТ 19.106-78]

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

Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа [из п. 2.9.1 ГОСТ 19.106-78]

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

При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например, Приложение 1, Приложение 2 и т.д.

При выпуске приложения отдельным документом на титульном листе под видом документа следует указывать слово «Приложение», а при наличии нескольких приложений указывают также их порядковые номера.

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

Допускается объединять несколько приложений в отдельную часть программного документа [из п. 2.9.2 ГОСТ 19.106-78]

Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению [из п. 2.9.3 ГОСТ 19.106-78]

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

Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения [из п. 2.9.4 ГОСТ 19.106-78]

На приложения должны быть даны ссылки в основном тексте документа.

Все приложения должны быть перечислены в листе «Содержание» [из п. 2.9.5 ГОСТ 19.106-78]

Примечания [из подр. 2.7 ГОСТ 19.106-78]

Примечания [из подр. 2.7 ГОСТ 19.106-78]

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

Одно примечание не нумеруется. После слова «Примечание» ставят точку.

Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечания» ставят двоеточие.

Например:

Примечание._____________________________________________________________________________

__________________________________________________________________________________________

или

Примечания:

1. _______________________________________________________________________________________

__________________________________________________________________________________________

2. ________________________________________________________________________________________

___________________________________________________________________________________________

[из п. 2.7.1 ГОСТ 19.106-78]

Текст примечаний допускается печатать через один интервал [из п. 2.7.2 ГОСТ 19.106-78]

Сокращения [из подр. 2.8 ГОСТ 19.106-78]

Сокращения [из подр. 2.8 ГОСТ 19.106-78]

Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:

Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений [из п. 2.8.1 ГОСТ 19.106-78]

Ссылки [из подр. 2.5 ГОСТ 19.106-78]

Ссылки [из подр. 2.5 ГОСТ 19.106-78]

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

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

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

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

[из п. 2.5.1 ГОСТ 19.106-78]

Таблицы [из подр. 2.6 ГОСТ 19.106-78]

Таблицы [из подр. 2.6 ГОСТ 19.106-78]

Цифровой материал для достижения лучшей наглядности и сравнимости показателей, как правило, следует оформлять в виде таблицы [из п. 2.6.1 ГОСТ 19.106-78]

Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5-85.

Таблица может иметь заголовок, который следует выполнять строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры [из п. 2.6.2 ГОСТ 19.106-78]

Сноски к таблицам располагают непосредственно под таблицей, например:

Наборы данных, используемые для распечатки

Назначение

Стандартное имя

Используемое устройство

Для информационной распечатки

SSSSSSS1)

Печатающее устройство2)

Для распечатки во время выполнения программы

РРРРРРРР

Печатающее устройство2)

  1. Имя SSSSSSS должно быть задано при настройке операционной системы.
  2. Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.

[из п. 2.6.3 ГОСТ 19.106-78]

Текст документа [из подр. 2.2 ГОСТ 19.106-78]

Текст документа [из подр. 2.2 ГОСТ 19.106-78]

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

Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов [из п. 2.2.1 ГОСТ 19.106-78]

Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений [из п. 2.2.2 ГОСТ 19.106-78]

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

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

ТО=устройство=список - указывает носители данных, на которые осуществляется...

АВС3091 СИНТАКСИЧЕСКАЯ ОШИБКА

ПРИЧИНА. Указанный в сообщении...

ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется...

ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить...

Необходимые пояснения к тексту документа могут оформляться сносками.

Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)...».

Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы [из п. 2.2.4 ГОСТ 19.106-78]

Требования к программным документам, содержащим текст, разбитый на графы [из разд. 3 ГОСТ 19.106-78]

Требования к программным документам, содержащим текст, разбитый на графы [из разд. 3 ГОСТ 19.106-78]

Программные документы, содержащие текст, разбитый на графы, при необходимости разделяют на разделы и подразделы, которые не нумеруют. Допускается линии, разграничивающие строки и графы, не наносить [из п. 3.1 ГОСТ 19.106-78]

Наименования разделов и подразделов записывают в виде заголовков строчными буквами (кроме первой прописной) и подчеркивают.

Расстояния между заголовком и последующим текстом, между текстом и последующим заголовком и между заголовками должны соответствовать указанным в п. 2.1.8 [из п. 3.2 ГОСТ 19.106-78]

Примечания в документе оформляют в порядке, изложенном в п. 2.7 [из п. 3.3 ГОСТ 19.106-78]

В таблицах и формах, имеющих строки, все записи размещают на каждой строке в один ряд.

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

Следует оставлять свободные строки между разделами и подразделами, а в документах большого объема - также внутри разделов и подразделов.

Если в графе документа записан текст в несколько строк, то в последующих графах записи начинают на уровне первой строки. Допускается помещать запись на уровне последней строки, если она занимает одну строку [из п. 3.4 ГОСТ 19.106-78]

Формулы [из подр. 2.4 ГОСТ 19.106-78]

Формулы [из подр. 2.4 ГОСТ 19.106-78]

Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках, на уровне формулы.

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

Ссылки в тексте на порядковый номер формулы дают в скобках, например: «в формуле (3)».

При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: «в формуле (1.4)» [из п. 2.4.1 ГОСТ 19.106-78]

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

Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить [из п. 2.4.2 ГОСТ 19.106-78]

Размерность одного и того же параметра в пределах одного документа должна быть постоянной [из п. 2.4.3 ГОСТ 19.106-78]

Виды программ [из разд. 1 ГОСТ 19.101-77]

Виды программ [из разд. 1 ГОСТ 19.101-77]

Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ [из п. 1.1 ГОСТ 19.101-77]

Программы подразделяют на виды, приведенные в таблице.

Вид программы

Определение

Компонент

Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса

Комплекс

Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса

[из п. 1.2 ГОСТ 19.101-77]

Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия [из п. 1.3 ГОСТ 19.101-77]

Виды программных документов [из разд. 2 ГОСТ 19.101-77]

Виды программных документов [из разд. 2 ГОСТ 19.101-77]

К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ [из п. 2.1 ГОСТ 19.101-77]

Виды программных документов и их содержание приведены в таблице.

Вид программного документа

Содержание программного документа

Спецификация

Состав программы и документации на нее

Ведомость держателей подлинников (Ведомость держателей подлинников по ГОСТ 19.403-79, 🔍, ) Ведомость держателей подлинников по ГОСТ 19.403-79 - диаграмма Гантта

Перечень предприятий, на которых хранят подлинники программных документов

Текст программы Текст программы по ГОСТ 19.401-78Текст программы по ГОСТ 19.401-78 - диаграмма Гантта

Запись программы с необходимыми комментариями

Описание программы Описание программы по ГОСТ 19.402-78Описание программы по ГОСТ 19.402-78 - диаграмма Гантта

Сведения о логической структуре и функционировании программы

Программа и методика испытаний Программа и методика испытаний по ГОСТ 19.301-79Программа и методика испытаний по ГОСТ 19.301-79

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

Техническое задание Техническое задание по ГОСТ 19.201-78 (🔍, , Гантт)Техническое задание по ГОСТ 19.201-78 - диаграмма Гантта

Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний

Пояснительная записка Пояснительная записка по ГОСТ 19.404-79Пояснительная записка по ГОСТ 19.404-79 - диаграмма Гантта

Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений

Эксплуатационные документы

Сведения для обеспечения функционирования и эксплуатации программы

[из п. 2.2 ГОСТ 19.101-77]

Виды эксплуатационных документов и их содержание приведены таблице.

Вид эксплуатационного документа

Содержание эксплуатационного документа

Ведомость эксплуатационных документов

Перечень эксплуатационных документов на программу

Формуляр Формуляр по ГОСТ 19.501-78Формуляр по ГОСТ 19.501-78 - диаграммма Гантта

Основные характеристики программы, комплектность и сведения об эксплуатации программы

Описание применения Описание применения по ГОСТ 19.502-78Описание применения по ГОСТ 19.502-78 - диаграмма Гантта

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

Руководство системного программиста Руководство системного программиста по ГОСТ 19.503-79Руководство системного программиста по ГОСТ 19.503-79 - диаграмма Гантта

Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения

Руководство программиста Руководство программиста по ГОСТ 19.504-79Руководство программиста по ГОСТ 19.504-79 - диаграмма Гантта

Сведения для эксплуатации программы

Руководство оператора Руководство оператора по ГОСТ 19.505-79Руководство оператора по ГОСТ 19.505-79 - диаграмма Гантта

Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание языка

Описание синтаксиса и семантики языка

Руководство по техническому обслуживанию

Сведения для применения тестовых и диагностических программ при обслуживании технических средств

[из п. 2.3 ГОСТ 19.101-77]

В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы [из п. 2.4 ГОСТ 19.101-77]

Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в таблице.

Код вида документа

Вид документа

Стадии разработки

Эскизный проект

Технический проект

Рабочий проект

компонент

комплекс

-

Спецификация

-

-

- Кружок полузалитый

- Кружок залитый

05

Ведомость держателей подлинников (Ведомость держателей подлинников по ГОСТ 19.403-79, 🔍, ) Ведомость держателей подлинников по ГОСТ 19.403-79Ведомость держателей подлинников по ГОСТ 19.403-79 - диаграмма Гантта

-

-

-

- Кружок

12

Текст программы Текст программы по ГОСТ 19.401-78Текст программы по ГОСТ 19.401-78 - диаграмма Гантта

-

-

- Кружок залитый

- Кружок

13

Описание программы Описание программы по ГОСТ 19.402-78Описание программы по ГОСТ 19.402-78 - диаграмма Гантта

-

-

- Кружок

- Кружок

20

Ведомость эксплуатационных документов Ведомость держателей подлинников по ГОСТ 19.403-79Ведомость держателей подлинников по ГОСТ 19.403-79 - диаграмма Гантта

-

-

- Кружок

- Кружок

30

Формуляр Формуляр по ГОСТ 19.501-78Формуляр по ГОСТ 19.501-78 - диаграммма Гантта

-

-

- Кружок

- Кружок

31

Описание применения Описание применения по ГОСТ 19.502-78Описание применения по ГОСТ 19.502-78 - диаграмма Гантта

-

-

- Кружок

- Кружок

32

Руководство системного программиста Руководство системного программиста по ГОСТ 19.503-79Руководство системного программиста по ГОСТ 19.503-79 - диаграмма Гантта

-

-

- Кружок

- Кружок

33

Руководство программиста Руководство программиста по ГОСТ 19.504-79Руководство программиста по ГОСТ 19.504-79 - диаграмма Гантта

-

-

- Кружок

- Кружок

34

Руководство оператора Руководство оператора по ГОСТ 19.505-79Руководство оператора по ГОСТ 19.505-79 - диаграмма Гантта

-

-

- Кружок

- Кружок

35

Описание языка

-

-

- Кружок

- Кружок

46

Руководство по техническому обслуживанию

-

-

- Кружок

- Кружок

51

Программа и методика испытаний Программа и методика испытаний по ГОСТ 19.301-79Программа и методика испытаний по ГОСТ 19.301-79

-

-

- Кружок

- Кружок

81

Пояснительная записка Пояснительная записка по ГОСТ 19.404-79Пояснительная записка по ГОСТ 19.404-79 - диаграмма Гантта

- Кружок

- Кружок

-

-

90-99

Прочие документы

- Кружок

- Кружок

- Кружок

- Кружок

Условные обозначения:

- Кружок залитый - документ обязательный;

- Кружок полузалитый - документ обязательный для компонентов, имеющих самостоятельное применение;

- Кружок - необходимость составления документа определяется на этапе разработки и утверждения технического задания;

- - документ не составляют.

[из п. 2.5 ГОСТ 19.101-77]

Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ [из п. 2.6 ГОСТ 19.101-77]

На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы. Технические условия разрабатывают на стадии «Рабочий проект» [из п. 2.7 ГОСТ 19.101-77]

Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком [из п. 2.8 ГОСТ 19.101-77]

Страницы

Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика