Блог технического писателя Ильи Жукова

Примечания и предупреждения в тексте инструкций

Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложении с большой буквы и наставить кучу восклицательных знаков. Можно смешать все способы выделения. А можно использовать стандартную систему примечаний и предупреждений — информационные врезки.

 

Если смешать все средства выделения, получится примерно следующая гремучая смесь:

!!!!!!МОЖНО НАПИСАТЬ ВСЕ СЛОВА В ПРЕДЛОЖЕНИИ С БОЛЬШОЙ БУКВЫ И НАСТАВИТЬ КУЧУ ВОСКЛИЦАТЕЛЬНЫХ ЗНАКОВ!!!!!

 

А вот пример хорошей информационной врезки в WebHelp.

пример информационной врезки

 

Что такое врезка

 

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

 

Врезка - это полиграфический термин. Он обозначает художественно оформленный фрагмент текста внутри полосы. Иногда этот текст содержит заголовок и рисунок. Такой прием верстки почти всегда используется в печатных журналах, реже - в газетах. В электронных изданиях врезки почти не используются. Для описания примечаний и предупреждений существует и другой термин: маркировочные структурные элементы (Кагарлицкий 2012: 111). В англоязычной литературе для обозначения примечаний и предупреждений специальные термины не применяются, только note (примечание) и notice (примечание, предупреждение, пометка).

 

Вот еще несколько примеров информационных врезок.

 

информационная врезка примечание

информационная врезка совет

Структура врезки

 

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

 

Какие бывают врезки

 

Единой общепринятой системы информационных врезок не существует. Есть только несколько национальных стандартов на предупредительные надписи: ANSI Z535, ISO 3864 и ISO 7010. Поэтому, если в техническом задании или в руководстве по стилю заказчика нет специальных требований к маркировке информации, каждый технический писатель предпочитает использовать свою систему врезок. Обычно такая система состоит из нескольких типов врезок, выделяемых по цели и важности информации. Важность может варьироваться от нейтрального до критического значения. Каждому типу врезки может соответствовать своя цветовая маркировка.

 

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

 

примечание  

Примечание    Примечание (от англ. Note) обычно содержит небольшие пояснения, помогающие пользователю быстрее освоить работу с программным продуктом.

важно   Важно!    Врезка "Важно!" (от англ. Important!) обычно содержит важные замечания, призванные акцентировать внимание пользователя на теме, информации и т.п.
дополнительная информация   Дополнительная информация    Врезка "Дополнительная информация" (от англ. You should know it) обычно содержит блок дополнительной информации, по объему больший, чем примечание.
совет   Совет    Врезка "Совет" (от англ. Tip) обычно содержит совет, например, какой из нескольких предложенных способов выполнения задачи в каком случае предпочтительно выбрать и т.п.
предостережение   Предостережение    Врезка "Предостережение" (от англ. Caution) обычно содержит предостережение о нежелательных или неизвестных последствиях (потеря данных, неполадки оборудования и т.п.).
Осторожно   Осторожно!    Врезка "Осторожно!" (от англ. Warning) обычно содержит предупреждение об известных серьезных и опасных последствиях (Не влезай - убьет!).

 

Реализовать их можно, например, следующим образом:

 

пример реализации врезок

Для чего используются врезки

  • Врезки позволяют привлечь внимание пользователя к важной информации.
  • Врезки показывают пользователю степень важности выделенной информации.
  • Врезки облегчают поиск необходимой информации во время беглого просмотра / сканирующего чтения.
  • Врезки чистят текст от "шума": выделение всех слов в предложении жирным, курсивом, подчеркиванием, цветным шрифтом, БОЛЬШИМИ БУКВАМИ и т.п.
  • Информационные врезки делают пользовательскую документацию более человечной, приветливой.

 

 

3 комплекта значков для примечаний

Хотите получить 3 комплекта значков для примечаний бесплатно в хорошем качестве? Заполните, пожалуйста, форму.

 

 

Источники и дополнительная информация

  1. Возвышаева Н. ANSI Z535.6 — стандарт на предупредительные врезки в технической документации, 2012 (ссылка в настоящее время не работает).
  2. Американский стандарт ANSI Z535.
  3. Предупредительные формулировки (англ.яз.).
  4. Ugur Akinci. How to Write Notes, Cautions, and Warnings in Technical Documents.

 

Добавить комментарий

Последние статьи

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual

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

Читать полностью...

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

Читать полностью...

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

Читать полностью...

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
вычитка текста

Как вычитать свой текст: инструкция для …

В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и...

Читать полностью...
качество текста

Как повысить качество текста инструкций

Каждый автор знает: во время написания и правки текста глаз замыливается. Смотришь в текст и читаешь не то, что написано, а то, что хочешь видеть. В этой статье я расс...

Читать полностью...

Закон построения нехудожественного текст…

Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собо...

Читать полностью...

Методика чтения научных книг

Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, ...

Читать полностью...

Книга «Пиши, сокращай: как создавать сил…

Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв...

Читать полностью...

Как починить поиск в русском PDF

Начинающий пользователь Help+Manual, пишущий документацию на русском языке, рано или поздно сталкивается с ситуацией, когда в созданном PDF-документе не работает поиск...

Читать полностью...

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

Читать полностью...

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

Читать полностью...

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2022. Охраняется законом об авторском праве.