Форматирование текста в техническом письме (процедурное письмо)

В процедуре при описании компонента пользовательского интерфейса мы используем полужирный шрифт для представления компонентов пользовательского интерфейса. Мы также сопоставляем текст с регистром букв компонента пользовательского интерфейса. Но нужно ли нам также соответствовать стилю шрифта? Например, если компонент пользовательского интерфейса выделен курсивом, нужно ли нам писать текст курсивом?

Просто чтобы убедиться, что вы используете «UI» для обозначения «User Interface», да?
Использование курсивного шрифта для элементов управления в большинстве графических интерфейсов является нестандартным. Это что-то кроме программного обеспечения или машинного интерфейса?

Ответы (3)

Это все о признании. Пользователь может распознать упоминаемый компонент по имени (вербально) или визуально (визуально). В большинстве случаев достаточно узнавания по имени.

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

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

Однако нет смысла что-то делать между этими двумя. Если визуальное соответствие не является полным, то либо визуальное соответствие читателя будет сбито с толку, либо он вернется к вербальному сопоставлению, и в этом случае выбор шрифта и т. д. не имеет значения.

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

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

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

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

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