Документ

Обозначения программ и программных документов по ГОСТ 19.103-77

Обозначения программ и программных документов по ГОСТ 19.103-77

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

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

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

Структура обозначения программы и ее программного документа - спецификации:

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

[из п. 3 ГОСТ 19.103-77]

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

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

[из п. 4 ГОСТ 19.103-77]

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

Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом, в установленном порядке.

До утверждения Общесоюзного классификатора программ допускается присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.

Номер издания программы или номер редакции документа присваивают в порядке возрастания с 01 до 99 [из п. 5 ГОСТ 19.103-77]

Код вида документа присваивают в соответствии с требованиями ГОСТ 19.101-77 [из п. 6 ГОСТ 19.103-77]

Номер документа данного вида присваивают в порядке возрастания с 01 до 99 [из п. 7 ГОСТ 19.103-77]

Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9.

Примечание - Если документ состоит из одной части, то дефис и порядковый номер части не указывают [из п. 8 ГОСТ 19.103-77]

Номер редакции спецификации и ведомости эксплуатационных документов на программу должен совпадать с номером издания этой же программы [из п. 9 ГОСТ 19.103-77]

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

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

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

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

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

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

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

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

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

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

Рамку (границы) формата страниц документа допускается не наносить [из п. 2.1.2 ГОСТ 19.106-78]

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

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

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

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

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

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

Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.

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

Подраздел - часть раздела, обозначенная номером и имеющая заголовок.

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

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

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

При отсутствии разделов в тексте документа его первым структурным элементом является пункт.

Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.

Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом.

Не рекомендуется делать ссылки на элементы перечисления.

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

Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.

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

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

Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.

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

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

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

  • при выполнении документа машинописным способом - двум интервалам;
  • при выполнении рукописным способом - 10 мм;
  • при выполнении машинным способом - не менее трех высот шрифта.

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

  • при выполнении документа машинописным способом - трем машинописным интервалам;
  • при выполнении рукописным способом - не менее 15 мм;
  • при выполнении машинным способом - не менее четырех высот шрифта.

Расстояние между основаниями строк заголовка принимают таким, как в тексте.

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

Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.

Разделы должны иметь порядковый номер (1, 2 и т.д.).

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

Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3.1 и т.д.).

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

Пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов приведен в справочном приложении 2 [из п. 2.1.9 ГОСТ 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 ГОСТ 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]

Внесение изменений в общий топик и экспорт документов из Confluence в MS Word

Внесение изменений в общий топик и экспорт документов из Confluence в MS Word

Экспорт взаимоувязанных документов из Atlassian Confluence в Microsoft™ Word выполняется из текущего рабочего пространства выбором пункта из того же меню, что использовалось для импорта, только Export to Word, см. рисунок из подраздела Импорт документов из Microsoft™ Word в Atlassian Confluence. Но сначала следует внести изменение в любой из общих топиков, чтобы совсем уж было очевидно, что библиотека взаимоувязанных документов, сформированная в предыдущем подразделе, реально работает. Редакция от 13.08.2020.

Подготовка взаимоувязанных документов к импорту в Confluence

Подготовка взаимоувязанных документов к импорту в Confluence

Для импорта взаимоувязанных документов из библиотек из AuthorIT Workgroup Edition в Atlassian Confluence необходимо провести некоторые подготовительные операции. Автор заранее подготовил, вернее, «подчистил» пару боевых документов из проекта так, чтобы они были небольшими по объему и быстро импортировались в Atlassian Confluence, но при этом содержали «пересекающиеся», т.е. общие топики в структуре каждого из документов. На картинках общие топики отмечены значком - Пиктограмма с блокировкой. Редакция от 13.08.2020.

Документы, содержащие текст, разбитый на графы [из разд. 3 ГОСТ 24.301-80]

Документы, содержащие текст, разбитый на графы [из разд. 3 ГОСТ 24.301-80]

Наименования разделов и подразделов записывают в графу «Наименование» ведомостей документов или описи.

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

Заимствованные документы рекомендуется записывать в ведомости в конце каждого раздела, подраздела [из п. 3.1 ГОСТ 24.301-80]

Требования к построению и другие общие требования к заполнению граф должны соответствовать разд. 3 ГОСТ 2.105 [из п. 3.2 ГОСТ 24.301-80]

Ведомость технического проекта, ведомость рабочей документации, ведомость проекта выполняют в соответствии с разд. 4 ГОСТ 2.106 [из п. 3.3 ГОСТ 24.301-80]

Опись составляют при необходимости брошюрования документов в книгу, альбом, папку. Опись является первым документом книги, альбома, папки. Опись эксплуатационных документов выполняют в соответствии с разд. 3 ГОСТ 2.601. Прочие описи выполняют в соответствии с разд. 2 ГОСТ 2.105 [из п. 3.4 ГОСТ 24.301-80]

Страницы

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

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

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