Оформление

3.1.1 Оформление технического документа в соответствии с заданным стандартом (А/01.4)

3.1.1 Оформление технического документа в соответствии с заданным стандартом (А/01.4)

Оформление технического документа в соответствии с заданным стандартом (А/01.4) - трудовая функция, присвоенная профессиональным стандартом рабочим и служащим, квалификация которых позволяет занимать должности технического писателя-стажера, младшего технического писателя или оформителя технической документации.

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

Правила оформления [из разд. 3 ГОСТ 34.602-89]

Правила оформления [из разд. 3 ГОСТ 34.602-89]

Разделы и подразделы ТЗ на АС должны быть размещены в порядке, установленном в разд. 2 настоящего стандарта [из п. 3.1 ГОСТ 34.602-89]

ТЗ на АС оформляют в соответствии с требованиями ГОСТ 2.105 на листах формата A4 по ГОСТ 2.301 без рамки, основной надписи и дополнительных граф к ней. Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, в верхней части листа (над текстом, посередине) после обозначения кода ТЗ на АС [из п. 3.2 ГОСТ 34.602-89]

Значения показателей, норм и требований указывают, как правило, с предельными отклонениями или максимальным и минимальным значениями. Если эти показатели, нормы, требования однозначно регламентированы НТД, в ТЗ на АС следует приводить ссылку на эти документы или их разделы, а также дополнительные требования, учитывающие особенности создаваемой системы. Если конкретные значения показателей, норм и требований не могут быть установлены в процессе разработки ТЗ на АС, в нем следует сделать запись о порядке установления и согласования этих показателей, норм и требований:

«Окончательное требование (значение) уточняется в процессе... и согласовывается протоколом с... на стадии...».

При этом в текст ТЗ на АС изменений не вносят [из п. 3.3 ГОСТ 34.602-89]

На титульном листе помещают подписи заказчика, разработчика и согласующих организаций, которые скрепляют гербовой печатью. При необходимости титульный лист оформляют на нескольких страницах. Подписи разработчиков ТЗ на АС и должностных лиц, участвующих в согласовании и рассмотрении проекта ТЗ на АС, помещают на последнем листе. Форма титульного листа ТЗ на АС приведена в приложении 2. Форма последнего листа ТЗ на АС приведена в приложении 3 [из п. 3.4 ГОСТ 34.602-89]

При необходимости на титульном листе ТЗ на АС допускается помещать установленные в отрасли коды, например: гриф секретности, код работы, регистрационный номер ТЗ и др. [из п. 3.5 ГОСТ 34.602-89]

Титульный лист дополнения к ТЗ на АС оформляют аналогично титульному листу технического задания. Вместо наименования «Техническое задание» пишут «Дополнение № ... к ТЗ на AC ... » [из п. 3.6 ГОСТ 34.602-89]

На последующих листах дополнения к ТЗ на АС помещают основание для изменения, содержание изменения и ссылки на документы, в соответствии с которыми вносятся эти изменения [из п. 3.7 ГОСТ 34.602-89]

При изложении текста дополнения к ТЗ следует указывать номера соответствующих пунктов, подпунктов, таблиц основного ТЗ на АС и т. п. и применять слова: «заменить», «дополнить», «исключить», «изложить в новой редакции» [из п. 3.8 ГОСТ 34.602-89]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию ИЭТР устанавливаются в соответствии с ГОСТ 2.610 и нормативными документами, применяемыми для конкретных видов техники, в зависимости от вида(ов) ЭД (РД), выполняемого(ых) в форме ИЭТР [из п. 5.3.1 ГОСТ Р 54088-2017]

Реквизитная часть информационных объектов в ОБДЭ и в локальной БД ИЭТР - по ГОСТ 2.058 [из п. 5.3.2 ГОСТ Р 54088-2017]

Для идентификации информационных объектов в ОБДЭ и в локальных БД в составе ИЭТР используют коды (например, код МД, код СЧ по каталогу, логистический контрольный номер СЧ и т.д.) определенного синтаксиса и формата [из п. 5.3.3 ГОСТ Р 54088-2017]

Коды информационных объектов в ОБДЭ должны быть постоянными для всего ЖЦ изделия [из п. 5.3.4 ГОСТ Р 54088-2017]

ИЭТР представляют в одной из двух форм: странично-ориентированной и полностью интерактивной.

В первом случае ИЭТР позволяет работать с изображениями страниц ЭД (РД), в том числе полученных путем сканирования страниц бумажной документации. Страницы могут быть индексированы в соответствии с содержанием, перечнем иллюстраций, таблиц и т. п. Индексация обеспечивает доступ для просмотра элементов данных сразу после выбора определенного элемента в содержании документа. Элементами могут быть размещенные на страницах ЭД (РД) главы, разделы, абзацы, списки, таблицы, иллюстрации и другие подобные информационные объекты. Допускаются перекрестные ссылки на разделы, таблицы, иллюстрации, аудио- и видеоданные, обеспечивается функция поиска данных. Странично-ориентированный формат позволяет получить бумажную форму ЭД (РД) без предварительной обработки данных в составе ИЭТР.

Во втором случае ИЭТР содержит локальную БД. ЭСО в составе ИЭТР обеспечивает полноценное интерактивное взаимодействие пользователя с указанной БД [из п. 5.3.5 ГОСТ Р 54088-2017]

Стиль изложения, язык и оформление документации [из подр. 5.2 ГОСТ Р 54087-2017]

Стиль изложения, язык и оформление документации [из подр. 5.2 ГОСТ Р 54087-2017]

Проверку стиля изложения, языка и оформления ЭД и РД осуществляет редактор. Целью проверки является установление соответствия документации заданным требованиям и при необходимости выработка предложений по корректировке проверенных частей документации [из п. 5.2.1 ГОСТ Р 54087-2017]

Редактор проверяет предъявленную ему часть документации и представляет информацию о выявленных недостатках в группу технических писателей для корректировки ЭД (РД) [из п. 5.2.2 ГОСТ Р 54087-2017]

Процесс проверки начинается с получения редактором документации от группы технических писателей. При этом руководитель разработки документации должен обеспечить редактору возможность обратной связи с группой технических писателей для предоставления информации о промежуточных и окончательных результатах проверки. По окончании проверки редактор принимает решение о стилистической корректности и правильности оформления документации. В случае принятия положительного решения процесс заканчивается. В противном случае документацию вместе с подробным описанием недостатков и рекомендуемых методов их устранения отсылают на доработку группе технических писателей [из п. 5.2.3 ГОСТ Р 54087-2017]

Для проведения указанных в 5.2.1-5.2.3 работ редактор должен знать стандарты подготовки технической документации в части ее оформления и изложения материала, а также специфику визуального представления данных в электронной ЭД и РД. В процессе проверки редактор контролирует:

[из п. 5.2.4 ГОСТ Р 54087-2017]

При необходимости процесс проверки стиля изложения, языка и оформления документации может повторяться по процедуре, устанавливаемой стандартом организации [из п. 5.2.5 ГОСТ Р 54087-2017]

По окончании проверки и устранения выявленных недостатков ЭД (РД) редактор принимает решение о надлежащем качестве стиля изложения, языка и оформления ЭД (РД) [из п. 5.2.6 ГОСТ Р 54087-2017]

1.3 Оформление отчета об обследовании [из п. 6.1.3 ГОСТ Р 58811-2020]

1.3 Оформление отчета об обследовании [из п. 6.1.3 ГОСТ Р 58811-2020]

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

На этапе 1.3 проводят оформление отчета об обследовании, содержащего собранные в ходе работ по этапу 1.2 документы, материалы и информацию, а также заключения и рекомендации по выбору площадки для создания ЦОД.

При необходимости отчет об обследовании может быть заменен документом с аналогичным содержанием. Форма и содержание отчетного документа по этапу определяется договором между заказчиком и исполнителем [из п. 6.1.3 ГОСТ Р 58811-2020]

Требования к построению, содержанию, изложению и оформлению ТЗ на ОКР по разработке КИМП [из подр. 8.1 ГОСТ 15.016-2016]

Требования к построению, содержанию, изложению и оформлению ТЗ на ОКР по разработке КИМП [из подр. 8.1 ГОСТ 15.016-2016]

Построение и содержание ТЗ на ОКР по разработке КИМП должно соответствовать требованиям, установленным в 6.1, с учетом специфики и особенностей создаваемого изделия, необходимых уточнений наименования отдельных разделов и подразделов, предусмотренных в настоящем разделе.

Допускается в зависимости от особенностей КИМП исключать отдельные разделы и подразделы, а также уточнять их содержание [из п. 8.1.1 ГОСТ 15.016-2016]

Наименование, шифр ОКР и основание для выполнения ОКР

В разделе «Наименование, шифр ОКР и основание для выполнения ОКР» указывают наименование, шифр ОКР и полное наименование документа, на основании которого должна выполняться ОКР, дату утверждения [из п. 8.1.2 ГОСТ 15.016-2016]

Цель выполнения ОКР и наименование изделия

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

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

Технические требования к изделию

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

Состав изделия

Подраздел «Состав изделия» предусматривают при необходимости [из пп. 8.1.4.1 ГОСТ 15.016-2016]

Требования назначения

В подразделе «Требования назначения» устанавливают параметры изделия и их нормы, режимы измерений, а также предельные значения допускаемых режимов эксплуатации [из пп. 8.1.4.2 ГОСТ 15.016-2016]

Требования электромагнитной совместимости

Подраздел «Требования электромагнитной совместимости» предусматривают при необходимости [из пп. 8.1.4.3 ГОСТ 15.016-2016]

Требования живучести и стойкости к внешним воздействиям

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

Характеристики внешних воздействующих факторов задают в соответствии с требованиями ГОСТ 21964 и стандартов на КИМП конкретных групп (видов).

При необходимости характеристики внешних воздействующих факторов конкретизируют с учетом особенностей эксплуатации и применения разрабатываемого изделия [из пп. 8.1.4.4 ГОСТ 15.016-2016]

Требования надежности

В подразделе «Требования надежности» устанавливают показатели надежности, номенклатуру и их конкретные значения, которые должны соответствовать требованиям стандартов на КИМП конкретных групп (видов) [из пп. 8.1.4.5 ГОСТ 15.016-2016]

Требования эргономики, обитаемости и технической эстетике и Требования к эксплуатации, хранению, удобству технического обслуживания и ремонта

Подразделы «Требования эргономики, обитаемости и технической эстетики» и «Требования к эксплуатации, хранению, удобству технического обслуживания и ремонта» предусматривают при необходимости [из пп. 8.1.4.6 ГОСТ 15.016-2016]

Транспортирование

В подразделе «Транспортирование» указывают вид транспортных средств, необходимость и способы крепления при перевозке, климатические условия при перевозке, специальные требования к изделию при перевозке (защита от ударов при погрузке и выгрузке и т.п.) [из пп. 8.1.4.7 ГОСТ 15.016-2016]

Требования безопасности

Подраздел «Требования безопасности» предусматривают при необходимости [из пп. 8.1.4.8 ГОСТ 15.016-2016]

Требования стандартизации, унификации и каталогизации

В подразделе «Требования стандартизации, унификации и каталогизации» устанавливают количественные и качественные показатели по стандартизации и унификации изделия, порядок и правила выполнения работ по каталогизации изделия [из пп. 8.1.4.9 ГОСТ 15.016-2016]

Требования технологичности

В подразделе «Требования технологичности» устанавливают показатели производственной технологичности [из пп. 8.1.4.10 ГОСТ 15.016-2016]

Конструктивные требования

В подразделе «Конструктивные требования» устанавливают требования к габаритным, установочным и присоединительным размерам изделия, способам его крепления, конструктивному оформлению, массе, климатическому исполнению и т.п. [из пп. 8.1.4.11 ГОСТ 15.016-2016]

Технико-экономические требования

В разделе «Технико-экономические требования» устанавливают лимитную стоимость ОКР, ориентировочную годовую потребность изделий (по данным заказчика) после окончания ОКР и их ориентировочную цену [из п. 8.1.5 ГОСТ 15.016-2016]

Требования к видам обеспечения

Раздел «Требования к видам обеспечения» предусматривают при необходимости [из п. 8.1.6 ГОСТ 15.016-2016]

Требования к сырью, материалам и КИМП

Раздел «Требования к сырью, материалам и КИМП» предусматривают при необходимости [из п. 8.1.7 ГОСТ 15.016-2016]

Требования к консервации, упаковке и маркировке

В разделе «Требования к консервации, упаковке и маркировке» устанавливают требования к консервации, упаковке изделия, вариантам упаковки в зависимости от условий хранения и транспортирования, а также требования к маркировке, наносимой на изделие (место нанесения, требования к содержанию и качеству маркировки) [из п. 8.1.8 ГОСТ 15.016-2016]

Требования к учебно-тренировочным средствам и Специальные требования

Разделы «Требования к учебно-тренировочным средствам» и «Специальные требования» предусматривают при необходимости [из п. 8.1.9 ГОСТ 15.016-2016]

Этапы выполнения ОКР

В разделе «Этапы выполнения ОКР» указывают перечень работ, выполняемых на этапах ОКР, установленных с учетом изложенных в 6.1.12, в том числе:

[из п. 8.1.10 ГОСТ 15.016-2016]

Порядок выполнения и приемки ОКР

В разделе «Порядок выполнения и приемки ОКР» с учетом порядка, изложенного в 6.1.13, указывают:

[из п. 8.1.11 ГОСТ 15.016-2016]

В приложениях к ТЗ приводят карту технического уровня, отчет о патентных исследованиях, перечень НД, использованных при выполнении ОКР по разработке КИМП, а также (при необходимости) таблицы, графики, схемы, расчеты, перечень справочно-информационных и других технических материалов и документов, необходимых для выполнения ОКР [из п. 8.1.12 ГОСТ 15.016-2016]

ТЗ на ОКР должно быть оформлено в соответствии с общими требованиями к текстовым документам, установленным в ГОСТ 2.105, на листах формата А4 по ГОСТ 2.301 без рамки, основной надписи и дополнительных граф к ней. Номера листов (страниц) проставляют в правом верхнем углу листа (над текстом).

Форма титульного листа ТЗ на ОКР приведена в приложении А (форма 5). На последнем листе (странице) ТЗ после основного текста помещают подпись исполнителя ОКР [из п. 8.1.13 ГОСТ 15.016-2016]

Требования к построению, содержанию, изложению и оформлению ТЗ на составную часть ОКР [из подр. 7.1 ГОСТ 15.016-2016]

Требования к построению, содержанию, изложению и оформлению ТЗ на составную часть ОКР [из подр. 7.1 ГОСТ 15.016-2016]

Построение и изложение ТЗ на СЧ ОКР должны соответствовать требованиям, установленным в 6.1. Содержание разделов и подразделов ТЗ определяет головной исполнитель ОКР [из п. 7.1.1 ГОСТ 15.016-2016]

Требования ТЗ на СЧ ОКР должны обеспечивать выполнение требований ТЗ на ОКР, в которую она входит, и учитывать специфические условия применения СЧ в изделии в целом.

Сроки выполнения этапов СЧ ОКР и СЧ ОКР в целом (если они не указаны в ТЗ на ОКР) необходимо устанавливать применительно к срокам выполнения ОКР [из п. 7.1.2 ГОСТ 15.016-2016]

ТЗ на СЧ ОКР должно быть оформлено в соответствии с требованиями, изложенными в 6.2.1-6.2.3, за исключением расположения утверждающих и согласующих подписей.

Форма титульного листа ТЗ на СЧ ОКР приведена в приложении А (форма 4).

На последнем листе ТЗ на СЧ ОКР после основного текста помещают подписи разработчиков ТЗ и согласующие подписи других организаций (предприятий), предусмотренных в 7.2 (аналогично форме 2 приложения А) [из п. 7.1.3 ГОСТ 15.016-2016]

Подтверждение принятия акцепта, оформления заказа на покупку товаров и заключения договора купли-продажи по ГОСТ Р 57489-2017

Подтверждение принятия акцепта, оформления заказа на покупку товаров и заключения договора купли-продажи по ГОСТ Р 57489-2017

Продавцам рекомендуется при получении акцепта от покупателей незамедлительно направлять им подтверждение о его принятии, завершении оформления заказа на покупку товаров и заключении договора купли-продажи [из подр. 6.1 ГОСТ Р 57489-2017]

Страницы

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

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

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

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