Стиль

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

Рекомендации по стилю - Приложение D ГОСТ Р ЕН 15038-2014

Рекомендации по стилю - Приложение D ГОСТ Р ЕН 15038-2014

В рамках рекомендаций по стилю могут быть обозначены следующие аспекты:

  • синтаксис, предусматривающий пробелы, точки, запятые, точки с запятой, двоеточия, тире, скобки (круглые и квадратные), вопросительные знаки, восклицательные знаки, кавычки, апострофы, ударения, символы;
  • орфография, предусматривающая прописные и строчные буквы, конвенции, личные имена и звания, географические названия, наименования фирм и изделий, меры, научные обозначения, числа (дроби, области, римские цифры, дата, время) и единицы измерений, математические и другие научные символы, сокращения и акронимы, заимствования (слов и фраз из других языков), разделение на слоги, сложные слова, черточки, транслитерация, перевод в латинский алфавит);
  • форматирование, выделение шрифта и вид шрифта: круглый шрифт, жирный шрифт, курсив, подчеркивание, виды шрифта, общие символы (например, ©, ®, &, %, tm, #);
  • прочие рекомендации, включающие списки и таблицы, формат бумаги, нейтральность языка относительно пола, времена, сноски, указание источников (библиография), цитаты, блок-схемы, графики и иллюстрации, перевод дат и атрибутов;
  • адаптация к конвенциям (условиям), предусматривающая специфические для отдельных культур выражения и обстоятельства, обращения, базовые данные (цены, предложения, почтовые и электронные адреса, номера телефонов и факсов и т.д.), пересчет валют и единиц измерения, специфические для отдельных культур графики и прочая культурная специфика;
  • локализация программного обеспечения, включающая обозначения клавиш, морфосинтаксические конвенции для элементов пользовательского интерфейса: различные меню, диалоговые окна, сообщения об ошибках;
  • терминологические установки, контрольный язык, правила, запрещающие употребление определенных оборотов, лингвистические и специфические преференции для клиентов;
  • предотвращение типичных переводческих ошибок (например, ложные друзья переводчика, неродственные слова, лингвистическая интерференция, неправильный лингвистический регистр и т.д.).

[из прил. D ГОСТ Р ЕН 15038-2014]

Стиль (Style) по ГОСТ Р ИСО/МЭК 2382-23-2004

Стиль (Style) по ГОСТ Р ИСО/МЭК 2382-23-2004

Определенный набор инструкций по форматированию текста, позволяющих пользователю применять различные атрибуты с целью унифицировать форму документа путем применения единых характеристик для различных частей текста документа [из п. 23.06.37 ГОСТ Р ИСО/МЭК 2382-23-2004]

Набор стилей (Style sheet) по ГОСТ Р ИСО/МЭК 2382-23-2004

Набор стилей (Style sheet) по ГОСТ Р ИСО/МЭК 2382-23-2004

Ряд стилей, сохраненных в файле, которые определяют форму (макет) документа [из п. 23.06.38 ГОСТ Р ИСО/МЭК 2382-23-2004]

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

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

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

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