С какой целью могут применяться примечания в электронных документах
Перейти к содержимому

С какой целью могут применяться примечания в электронных документах

  • автор:

Вопросы и ответы по работе с системой КонсультантПлюс

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

На полях размещены:

  • основные выводы из практики (обзор «Важнейшая практика по статье»);
  • позиции судов;
  • позиции ведомств;
  • образцы заполнения документов;
  • ссылки на готовые решения и другие фирменные материалы КонсультантПлюс.

Примечания на правой панели упрощают работу с текстом нормативного правового акта и помогают правильно применять документ на практике.

  • Зачем нужны гипертекстовые ссылки в документах системы КонсультантПлюс?
  • Для чего нужна функция «Документ на контроле»?
  • Где указана информация об официальной публикации и порядке применения конкретного правового акта?
  • Для чего нужна кнопка «Избранное» в системе КонсультантПлюс?
  • Как быстро перейти к нужному пункту в открытом документе?

Урок 1. Изучение найденного документа: справка, примечания в тексте и ссылки в документе

Система КонсультантПлюс предоставляет много различных возможностей для анализа документов.

Информационная строка в верхней части окна с текстом документа и Справка к документу содержат важную информацию об особенностях применения документа. А примечания в тексте и ссылки в документе позволяют выяснить особенности применения отдельных его частей.

Справка к документу

    в Справке к документу содержится важная дополнительная информация, связанная с применением документа: — «Источник публикации» — информация о том, где и когда документ официально был опубликован — «Примечания к документу» — информация об особенностях его применения, например, о том, что документ утратил силу, или о том, что его отдельные положения вступят в силу с определенной даты — «Название документа» — полное название документа

для отдельных типов документов в Справке может содержаться и иная информация. Например, для законопроектов может указываться стадия рассмотрения законопроекта

Примечания в тексте документа

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

Ссылки в документе

Ссылки в тексте позволяют переходить в другие документы или их фрагменты без дополнительного поиска.

В системе КонсультантПлюс реализованы различные варианты ссылок.

Свойства ссылок

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

если документ утратил силу, ссылка отображается бледным цветом, а во всплывающей подсказке отмечается, что упомянутый документ утратил силу

список документов, полученных по умной ссылке, поддерживается в актуальном состоянии: добавляются новые документы и удаляются старые

Примеры с решением к уроку 1 »
Примеры для самостоятельной работы к уроку 1 »

* примеры рассчитаны на использование систем КонсультантПлюс, установленных в учебных классах вузов

Примечания в тексте документа

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

Такие примечания могут содержать:

· информацию об отмене частей документа;

· информацию о создании новой редакции фрагмента текста документа;

· информацию об изменении действия частей документа; в таких примечаниях приводится информация об изменении сроков действия документов, расширении круга вопросов, которые они решают, и т.п.;

· информацию о судебных решениях о применении частей документа;

· информацию об официальных разъяснениях о применении частей документа;

· информацию о фактической утрате силы частей документа;

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

C:\Users\loskutnikova\Pictures\кн кпл примеч.jpg

Примечания выделены в тексте цветом:

Если есть необходимость, примечания в тексте можно отключить с помощью кнопки «Ещё» , которая находится над текстом документа справа сверху. Нажав на неё, нужно выбрать опцию .

Но в этом случае система предупредит, что без этой информации возможно неправильное применение документа:

C:\Users\loskutnikova\Pictures\кн предупр скрыть прим.jpg

Нажимая на кнопку ОК, отключаем примечания и получаем «чистый» текст документа.

Обратите внимание, что при этом происходит отключение и примечаний КонсультантПлюс, и пользовательских комментариев к закладкам (если они были).

Чтобы вернуть примечания, с помощью той же кнопки необходимо выбрать опцию

Необходимо найти Письмо ФНС России от 10.08.2018 N АС-4-20/15566@ и изучить его.

Шаг 1. В строке Быстрого поиска задайте: АС-4-20/15566@ и нажмите кнопку «Найти».

C:\Users\loskutnikova\Pictures\бп док для примера.jpg

Шаг 2. Откройте Письмо ФНС России от 10.08.2018 N АС-4-20/15566@ «О представлении разъяснений».

C:\Users\loskutnikova\Pictures\прим рис1.jpg

Шаг 3. Обратите внимание, что в письме допущена опечатка в номере упоминаемого абзаца. Во время юридической обработки экспертами КонсультантПлюс она была найдена и оформлена в виде примечания. Без примечания, по неправильным реквизитам, можно не найти нужный абзац документа и не получить достоверную информацию.

При переходе по указанной ссылке открывается правильный фрагмент текста Федерального закона 54-ФЗ (именно 21 абзац), в котором содержится толкование термина «расчеты»:

C:\Users\loskutnikova\Pictures\прим рис2.jpg

Открывается так называемая синхронная редакция Федерального закона, именно та, которая была действующей 10 августа 2018 года на момент выхода письма.

По гиперссылке «Перейти в действующую редакцию» можно открыть тот же фрагмент в редакции, действующей сейчас:

C:\Users\loskutnikova\Pictures\кн фр по примеч дейст ред.jpg

Шаг 4. Примечание в тексте письма можно скрыть, если нажать на кнопку справа сверху, выбрать действие и нажать на кнопку ОК в открывающемся после этого окне.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Ваш адрес email не будет опубликован. Обязательные поля помечены *