Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложении с большой буквы и наставить кучу восклицательных знаков. Можно смешать все способы выделения. А можно использовать стандартную систему примечаний и предупреждений — информационные врезки.
Если смешать все средства выделения, получится примерно следующая гремучая смесь:
!!!!!!МОЖНО НАПИСАТЬ ВСЕ СЛОВА В ПРЕДЛОЖЕНИИ С БОЛЬШОЙ БУКВЫ И НАСТАВИТЬ КУЧУ ВОСКЛИЦАТЕЛЬНЫХ ЗНАКОВ!!!!!
А вот пример хорошей информационной врезки в WebHelp.
Что такое врезка
Информационная врезка - это способ выделения в тексте важной информации, а также ее маркировки по степени важности. Примечания и предупреждения привлекают внимание пользователя к какой-либо информации, а также сообщают, насколько эта информация важна. Информационные врезки также используются для введения в описание дополнительной информации, которую в основной текст иным образом не вставить. Если информационными врезками не злоупотреблять, они будут эффективно привлекать внимание пользователей.
Врезка - это полиграфический термин. Он обозначает художественно оформленный фрагмент текста внутри полосы. Иногда этот текст содержит заголовок и рисунок. Такой прием верстки почти всегда используется в печатных журналах, реже - в газетах. В электронных изданиях врезки почти не используются. Для описания примечаний и предупреждений существует и другой термин: маркировочные структурные элементы (Кагарлицкий 2012: 111). В англоязычной литературе для обозначения примечаний и предупреждений специальные термины не применяются, только note (примечание) и notice (примечание, предупреждение, пометка).
Вот еще несколько примеров информационных врезок.
Структура врезки
С точки зрения структуры, информационная врезка состоит из заголовка и текста. Текст может содержать несколько предложений и быть оформлен в виде маркированного или нумерованного списка. С точки зрения оформления, врезка может содержать специальное изображение (значок для данного типа врезки) и быть выделенной при помощи рамки, фона, шрифта, цвета, отступов и т.д.
Какие бывают врезки
Единой общепринятой системы информационных врезок не существует. Есть только несколько национальных стандартов на предупредительные надписи: ANSI Z535, ISO 3864 и ISO 7010. Поэтому, если в техническом задании или в руководстве по стилю заказчика нет специальных требований к маркировке информации, каждый технический писатель предпочитает использовать свою систему врезок. Обычно такая система состоит из нескольких типов врезок, выделяемых по цели и важности информации. Важность может варьироваться от нейтрального до критического значения. Каждому типу врезки может соответствовать своя цветовая маркировка.
Я обычно использую следующие типы информационных врезок:
 |
Примечание Примечание (от англ. Note) обычно содержит небольшие пояснения, помогающие пользователю быстрее освоить работу с программным продуктом. |
|
 |
Важно! Врезка "Важно!" (от англ. Important!) обычно содержит важные замечания, призванные акцентировать внимание пользователя на теме, информации и т.п. | |
 |
Дополнительная информация Врезка "Дополнительная информация" (от англ. You should know it) обычно содержит блок дополнительной информации, по объему больший, чем примечание. | |
 |
Совет Врезка "Совет" (от англ. Tip) обычно содержит совет, например, какой из нескольких предложенных способов выполнения задачи в каком случае предпочтительно выбрать и т.п. | |
 |
Предостережение Врезка "Предостережение" (от англ. Caution) обычно содержит предостережение о нежелательных или неизвестных последствиях (потеря данных, неполадки оборудования и т.п.). | |
 |
Осторожно! Врезка "Осторожно!" (от англ. Warning) обычно содержит предупреждение об известных серьезных и опасных последствиях (Не влезай - убьет!). |
Реализовать их можно, например, следующим образом:
Для чего используются врезки
- Врезки позволяют привлечь внимание пользователя к важной информации.
- Врезки показывают пользователю степень важности выделенной информации.
- Врезки облегчают поиск необходимой информации во время беглого просмотра / сканирующего чтения.
- Врезки чистят текст от "шума": выделение всех слов в предложении жирным, курсивом, подчеркиванием, цветным шрифтом, БОЛЬШИМИ БУКВАМИ и т.п.
- Информационные врезки делают пользовательскую документацию более человечной, приветливой.
3 комплекта значков для примечаний
Хотите получить 3 комплекта значков для примечаний бесплатно в хорошем качестве? Заполните, пожалуйста, форму.
Источники и дополнительная информация
- Возвышаева Н. ANSI Z535.6 — стандарт на предупредительные врезки в технической документации, 2012 (ссылка в настоящее время не работает).
- Американский стандарт ANSI Z535.
- Предупредительные формулировки (англ.яз.).
- Ugur Akinci. How to Write Notes, Cautions, and Warnings in Technical Documents.
