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

Аннотация

Настоящий документ представляет собой Текст программы ПК «Интероперабельность».

Документ предназначен для участников команды проекта, осуществляющих разработку ПК «Интероперабельность», а также персонала ФГУП «Спецтяжмонтажстройсельхозавтоматика», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению, модификации или модернизации.

Документ разработан согласно ГОСТ 19.401-78, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части - по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.

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

Функциональное назначение:

• автоматическое формирование запроса (ссылки), содержащего заголовок (title) текущей страницы в качестве фактического параметра;
• автоматизированная отправка запроса в онлайновые сервисы поиска;
• автоматическое формирование запроса (ссылки), содержащего адрес (URL) текущей страницы в качестве фактического параметра;
• автоматизированная отправка запроса в онлайновые сервисы анализа.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• классификационной характеристики в обозначении;
• порядкового регистрационного номера в одной классификационной характеристике;
• номеров частей документов.

Заимствованные документы рекомендуется записывать в ведомости в конце каждого раздела, подраздела [из п. 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]