Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Когда следует использовать курсив?
 
Подскажите, пожалуйста, когда уместно использовать в документации выделение [i:39hgid1q]курсивом[/i:39hgid1q]?
 
Цитата
Подскажите, пожалуйста, когда уместно использовать в документации выделение [i:1p1ffula]курсивом[/i:1p1ffula]?

Пожалуйста, уточняйте, о какой документации идет речь - оформляемой по корпоративному  "коммерческому" стандарту или по "ГОСТу".

Строго по ГОСТу курсива нет вообще (там только  символы печатающей машинки).
Нет "жирного" текста (правда, на бумаге формально допускалось бить клавишу несколько раз по одному месту, создавая иллюзию "жирного" текста, но, потеряв бдительность, можно было пробить бумагу до дыр).

Оформление коммерческой документации ограничено вашей фантазией.
Курсивом можете выделять все, что хотите: вновь определяемые понятия.  пункты меню, название кнопки,  нецензурные выражения и т. п.
Обычно  в таких документах есть раздел "Принятые обозначения",  в котором и объясняются принятые в документе правила выделения элементов текста.
 
ГОСТ нам не нужен, просто чтобы было как положено))
 
Встречный вопрос. Кем "положено"? Если в организации уже существует документация, то, скорее всего, существуют и корпоративные регламенты, касающиеся оформления. Если нет - то еще лучше, Вам их и разробатывать. Единственное, что могу посоветовать - не злоупотреблять курсивом. Излишнее форматирование в документации осложняет ее восприятие.
 
Я курсив не использую никогда.
Но логично предположить, что вы хотите его использовать для выделения чего либо.
Согласная с остальными ребятами, посмотрите как в ранее созданых документах. Но как по мне, курсив не очень приятен для восприятия.
 
Дело вкуса. У нас стандартно (внутренний стандарт организации) курсивом выделяются пункты меню:"Для открытия формы МММ выберите пункт меню [i:2zahrbua]Файл>>>параметры>>>параметры настройки [/i:2zahrbua]".
Удобно искать глазами по тексту.
 
Цитата
Подскажите, пожалуйста, когда уместно использовать в документации выделение [i:29fann6j]курсивом[/i:29fann6j]?
У нас другим стилем (жирным/ курсивом) принято выделять названия элементов интерфейса (тематика ПО), например, пункты меню, названия кнопок, диалоговых окон, опций и проч. Для примеров и терминов выделяются отдельные стили.

Не совсем по теме, но на заметку: курсивом, правда, лучше не злоупотреблять. В качестве стиля для интерфейса, по-моему, он смотрится более менее прилично только со шрифтом Arial 10 - не напрягает глаза. Сочетание стилей, довольно широко распространенное за бугром: для обычного текста - Verdana 8-8,5, для названия элементов интерфейса - та же вердана, но полужирный. Пример оформления можно посмотреть здесь: http://www.quickbase.com/help/
Страницы: 1
Читают тему