Редполитика

Принципы

Текст, как любой контрол, должен выполнять полезное действие

Текст — элемент интерфейса, как кнопка или поле ввода. Он помогает решить интерфейсную задачу: объясняет непонятное и убеждает выполнить нужное действие. В интерфейсе ни одно предложение не появляется просто так. Уберите текст, если он не выполняет работу.

Пишите кратко

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

Пишите просто

Человек удерживает в памяти максимум 7 объектов, а оперирует — только двумя. Если каждое предложение в тексте сложносочиненное и состоит из нескольких простых, то пользователь не справится, а текст не выполнит задачу. Пишите проще.

Пишите убедительно

Нам важно, чтобы пользователь прочитал текст и согласился с нами: оплатил подписку на сервис, подписался на sms-уведомления, прочитал статью по сложной теме. Пишите убедительно, тогда с текстом не захочется спорить.

Информационный стиль текста

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

К сожалению, чтобы научиться писать хороший текст, недостаточно прочитать этот стандарт. Нужно ещё много теории и практики. К счастью, Максим написал гору материалов по теме:

Советы на сайте Бюро Горбунова,

Посты в его блоге,

Продвинутая рассылка Главреда. С домашними заданиями и без,

Книга «Пиши, сокращай», в соавторстве с Людой Сарычевой.

Синтаксис

Синтаксис — это раздел грамматики о составе предложения и порядке слов в предложении. Писать просто — значит писать так, чтобы синтаксис был простым.

В предложении есть подлежащее и сказуемое

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

Что почитать по теме:

«Страдательный залог: когда он нужен и не нужен»

«Хорошее и плохое подлежащее»

Подлежащее и сказуемое стоят рядом

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

Неправильно Правильно
Сюрприз для всех, кто жаждет обрести этой зимой внутреннее равновесие, красоту и здоровье, ждет в конце письма. В конце письма всех ждет сюрприз. Он поможет обрести внутренне равновесие, красоту и здоровье этой зимой.

Перенесите главное в начало предложения

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

Неправильно Правильно
На основе вашего ИНН мы нашли в базе ЕГРЮЛ и загрузили в Контур.Экстерн такие реквизиты: Контур.Экстерн заполнил реквизиты организации на основе данных из ЕГРЮЛ
Если на горизонте появляются новые заказчики, о существовании которых вы не подозревали, появляются новые требования от «старых» заказчиков, вы получаете кучу замечаний на финальном просмотре, значит вы плохо поработали с клиентом в начале проекта. Если плохо поработаете с клиентом в начале проекта, получите кучу новых требований, когда все будет готово. Разумеется, придется все переделать.
Совместно с коллегами, отвечающими за те или иные направления обустройства нового офиса, мы обобщили вопросы, которые вызывают беспокойство, и ниже приводим их обзор. Мы обобщили вопросы, которые беспокоят контуровцев больше всего.

Замените модальные глаголы на нормальные

Модальный глагол — слабый глагол, смысл которого раскрывается следующим за ним словом. Чтобы избавиться от модальности, возьмите отглагольное существительное, которое идет за ним, и образуйте от него глагол.

Неправильно Правильно
Осуществляет продажу Продает
Одержал победу Победил

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

Не используйте пассивный залог

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

Неправильно Правильно
В Блогове был опубликован пост Вася опубликовал пост в Блогове
Вам будет отправлено письмо со ссылкой для входа. Контур.Фокус отправит письмо со ссылкой для входа.
Ошибки, которые были допущены в планировании итерации, сказались на сроках реализации проекта. Мы ошиблись при планировании итерации и продолбали сроки.

Что почитать по теме:

http://artgorbunov.ru/bb/soviet/20140413/

«Если действующие лица неизвестны»

Не используйте текст в скобках

Текст в скобках нужен только в одном случае: когда у объекта два названия и вы не знаете, какое из них лучше известно вашей аудитории.

Правильно
Страдательный (пассивный) залог
Добавьте филиал (обособленное подразделение) организации

В остальных случаях текст в скобках не нужен. Он либо точнее того, что перед скобками, либо менее точен, либо самостоятельная мысль. Если текст в скобках лучше раскрывает мысль, выкиньте текст, который стоял перед скобками:

Неправильно Правильно
Обрпрограммы проводят образовательные мероприятия (стажировки, летние и онлайн-курсы) для студентов. Обрпрограммы проводят стажировки, летние и онлайн-курсы для студентов.

Если текст в скобках хуже раскрывает мысль, уберите его:

Неправильно Правильно
Обрпрограммы проводят стажировки, летние и онлайн-курсы (и др. образовательные мероприятия) для студентов. Обрпрограммы проводят стажировки, летние и онлайн-курсы для студентов.

Если текст в скобках — самостоятельная мысль, выделите ее в отдельное предложение:

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

Точка с запятой в предложении — признак слишком сложного синтаксиса

Замените причастие на нормальный глагол

Причастие — это глагол с признаками прилагательного, оно сложнее и слабее обычного глагола. Кроме того, причастие не стоит само по себе, а образует причастный оборот и этим усложняет синтаксис.

Неправильно Правильно
Статья, разъясняющая нюансы заполнения новой налоговой формы… В статье автор разъясняет нюансы заполнения новой налоговой формы…

Заменили причастие на нормальный глагол, сразу и действующее лицо появилось.

Неправильно Правильно
СКБ Контур — компания, разрабатывающая веб-сервисы для бизнеса. СКБ Контур разрабатывает веб-сервисы для бизнеса.

Что почитать по теме

«Отглагольное»

«Вложенные и причастные обороты»

Замените деепричастие на нормальный глагол

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

Неправильно Правильно
Проанализировав новый закон, мы пришли к выводу... Мы проанализировали новый закон и пришли к выводу…

Что почитать по теме:

«Отглагольное»

«Вложенные и причастные обороты»

Не ставьте в предложение больше трех однородных членов подряд и больше двух рядов однородных членов

После третьего однородного члена читатель перестает их запоминать. Три ряда по три однородных члена в каждом так же плохо, как один ряд с пятью-шестью однородными членами.

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

Используйте три однородных члена, чтобы сделать высказывание убедительным.

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

Один однородный член  отсутствие однородных членов помогает автору выделить главное, а читателю — понять, о чем сейчас пойдет речь.

Правильно Бухгалтеры любят Контур.Бухгалтерию за простоту использования.

Что почитать по теме:

«Однородные члены»

«Как сокращать однородные члены»

«Вложенные однородные члены»

Вереницы существительных в родительном падеже запрещены

«Друг подруги тёлки брата» — это сложно для понимания. Попробуйте «размотать» эту цепочку. Упростите или разделите на два предложения.

Неправильно Правильно
Данный ресурс является первоисточником требований к поведению и дизайну элементов пользовательского интерфейса внутренних и внешних веб-сервисов Контура. Контур.Гайды — первоисточник требований к элементам интерфейса. Эти требования распространяются на внутренние и внешние веб-сервисы Контура.

Эмоции

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

Милые картинки и шутки в тексте вызывают положительные эмоции у пользователя. Но пользователю не до шуток, если он столкнулся с проблемой, которая не дает ему выполнить сценарий. Если сервис недоступен или у пользователя неподходящий браузер, нужно помочь ему, а не развлечь.

Подключайте эмоции при редких и радостных событиях:

• Пользователь сдал всю отчетность,

• Завершил миграцию в ваш сервис,

• Не получил за год ни одного требования.

Полезно и правильно отмечать достижения пользователя, пытаться развлечь его в момент триумфа.

Набор капсом запрещен

Слова, набранные заглавными буквами, означают крик в речи, а мы не кричим на пользователей.

Старайтесь не использовать восклицательный знак

Вежливость

В веб-сервисах формы вежливости редко бывают уместны и еще реже нужны.

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

Здравствуйте

Здороваться обязательно в маркетинговых и новостных рассылках и запрещено в «технических» письмах.

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

Пожалуйста

Не просите пользователя сделать что-то через «пожалуйста». Лучше объясните пользу.

Неправильно Правильно
Пожалуйста, заполните карточку сотрудника. Такого сотрудника нет. Добавьте его, чтобы начислить зарплату.

Извините

Извиняться нужно, если проблема произошла по нашей вине. Если проблема возникла не по нашей вине, извиняться нельзя.

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

Правильно Извините, сервис недоступен. Мы знаем о проблеме и уже занимаемся ей.

Когда пользователь загрузит некорректный XML-файл отчета или фотографию вместо xml-файла, мы покажем ошибку без «извините». В таких случаях нужно просто сообщить о проблеме.

Правильно Это не отчет. Выберите другой файл.

Объявления и сообщения об ошибках

Если сообщение укладывается в одно—два простых предложения, заголовок не нужен

Часто в таких случаях добавляют бесполезный заголовок, чтобы был: «Уважаемые пользователи», «Важное объявление», «Внимание!» или «Убедительная просьба!». Последние два — признак сообщения, до которого никому нет дела.

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

Сразу к делу. В первом предложении напишите то, что вы хотите, чтобы пользователь узнал или сделал. Первым предложением — значит в заголовке, если он есть

Чтобы дойти до сути этого сообщения, придется дочитать до конца:

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

Если цель — не подписать как можно больше пользователей, а просто сообщить об изменениях, подходящий заголовок может быть таким:

Если вы видите, что заголовок получается слишком частным, а тема гораздо шире, то обобщите: «Изменился порядок ответа на требование». Так тоже можно, но только не «Уважаемые пользователи» и не «Вниманию налогоплательщиков». Налоговые инспекторы так могут писать, а мы — нет.

В веб-сервисах обращение к аудитории в заголовке бессмысленно. Заголовок «Уважаемые …» уместен, когда объявление нацелено на одно подмножество людей из всех, кто его увидит. Так бывает редко. Например, вы вешаете в коридоре объявление для дизайнеров Контура и хотите, чтобы его читали только дизайнеры. Или вы ищете программиста в своей проект — тогда заголовок «Программисты, есть работа!» будет к месту.

Когда в веб-сервисе пишут «Уважаемые пользователи», а в подъезде «Уважаемые жильцы и гости» — заголовок не выполняет работу, потому что кроме них не к кому обращаться.

Если произошла ошибка, напишите, что произошло, с точки зрения пользователя, а не с точки зрения системы

В мире пользователя он пытался войти в сервис и ввел логин и пароль. Про них он знает, мы только что у него спрашивали. Еще у него есть организация, а себя он считает пользователем. А про учетные записи он в общем случае не знает.

Неправильно Правильно
Произошла ошибка: На сервере anyservice.kontur.ru учетная запись не найдена. Мы не нашли такую организацию.

Заголовки сообщений об ошибках должны различаться

Это удобно пользователю и консультанту. Консультант техподдержки сможет по одному заголовку определить проблему. А пользователь при повторных ошибках сможет с первого предложения понять, что произошло и что делать дальше, не дочитывая сообщения до конца. Когда «Произошла неизвестная ошибка» — трудно будет всем.

Чтобы пользователь предотвратил проблему в следующий раз, обучите его

Расскажите пользователю, что делать, чтобы ошибка не возникала в будущем. Делайте это в последнюю очередь. Сначала пишем «что произошло», потом «как исправить» и только потом «что делать, чтобы такое не происходило».

Орфография и пунктуация

В правилах орфографии и пунктуации дизайнеры руководствуются

этим стандартом,

справочником Лопатина,

справочником Мильчина и Чельцовой.

В заголовках точки ставятся только между предложениями и не ставятся, если предложение одно

Знак вопроса в заголовке не ставится, если в заголовке стоит вопросительное слово, и ставится несмотря на вопросительное слово, если автор статьи задает вопрос читателям

Правильно
Как заполнить налоговую декларацию по НДС
Что нового в правилах заполнения табеля
Как вам новый расчет больничных?

Заголовок не может заканчиваться двоеточием

Даже если это заголовок списка и после него идет ряд однородных членов, двоеточие все равно не нужно.

Правильные кавычки — «кавычки-елочки» для первого уровня и „кавычки-лапки“ для второго уровня

В хинтах и тултипах точка ставится только между предложениями и не ставится, если предложение одно

Хинты и тултипы описывают назначение или работу элемента интерфейса. Они поясняют и подобны подписи к картинке. Поэтому к ним применяется правило подписи к картинке.

Буква «ё» используется только там, где возможно разночтение и из контекста не понятно, какое слово подразумевалось

все — всё

узнает — узнаёт

Малоизвестные имена собственные с буквой «ё»

Если из контекста не понятно, используется слово «все» или слово «всё», то букву «ё» необходимо оставить. Если разночтение невозможно или из контекста понятно, какое слово имелось в виду, используйте букву «е».

В веб-сервисах, на промосайтах, в почтовых рассылках и рекламных материалах «вы» пишется со строчной буквы

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

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

Мы уважаем наших пользователей и русский язык, поэтому пишем «вы». Если вам нужен ультраавторитетный источник, знайте, Д. Э. Розенталь на нашей стороне.

Слова «компания», «клиент» и остальные формы обращения пишутся со строчной, если это не первое слово в предложении

Вместо слов «функционал» и «функциональность» используйте менее сленговое слово «возможность». Еще лучше — сразу написать о том, что сервис научился делать

Неправильно Правильно
Появилась функциональность по расчету зарплаты для сотрудников с вредными условиями труда. Теперь Контур.Бухгалтерия считает зарплату сотрудникам с вредными условиями труда.
Появилась возможность считать зарплату сотрудникам с вредными условиями труда.

Имена собственные

Название «Контур» и названия продуктов склоняются. Не склоняется только «СКБ Контур»

Названия продуктов склоняются хоть со словом «контур», хоть без него.

Правильно
В Контур.Нормативе найдутся любые законы
В Нормативе найдутся любые законы

«СКБ Контур» не склоняется потому, что не склоняется аббревиатура внутри. Зато можно просклонять родовое слово перед ним.

Неправильно Правильно
в СКБ Контуре в компании «СКБ Контур»

«Рыба» в прототипах

Пишите реалистичную «рыбу», с настоящими реквизитами: ИНН, КПП, названиями организаций

Рамиль Шайхутдинов сделал плагин для Скетча RusBizGenerator. Он помогает вставлять в прототипы настоящие названия организаций, ФИО, ИНН и КПП, а еще генерирует номера, например ОГРН.

Вписывайте короткие, средние и длинные ФИО и адреса, а не те, которые с запасом влезают в поля

Пишите настоящие сообщения и ошибки из веб-сервиса, а не «Здесь текст ошибки»

Не пишите в прототипе «прикольные» и грубые имена и названия. Особенно в прототипе для тестирования

Не допускайте фактических и логических ошибок в прототипах

Бухгалтер разбирается в своей предметной области и сразу видит нестыковки. Фактические и логические ошибки в прототипе приводят к дискуссии с юзабилистом и мешают погружению в процесс.

Прототип с реквизитами настоящих организаций не должен выходить за пределы Контура. Для публикации в блогах и СМИ подготовьте скриншоты без реквизитов реальных организаций. Персональных данных людей это тоже касается

Термины

Используйте одни и те же слова для обозначения объектов и действий над ними

Если пользователь в одном окне прочитает «сертификат», в другом «КЭП», а в третьем — «ключ», у него не образуется связь между этими словами, он не поймет, что это одно и то же.

Чтобы избежать повтора в соседних предложениях, используйте разные способы указания

Для этого можно переходить с термина на местоимение или на имя собственное, а потом обратно. Переходить с одного термина на другой нельзя — такой текст будет путать пользователя.

Неправильно Правильно
Веб-сервис → Система → Сервис Веб-сервис → Диадок → Он
Сертфикат → Ключ → Электронная подпись Сертификат → Он

Как писать об оплате и продлении сервиса и о сертификате

Покупка и продление

Сервис можно купить либо оплатить. Когда сервис заканчивается, его можно продлить либо оплатить.

Пакет можно заказать, купить и оплатить.

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

Окончание

Сервис и сертификат могут закончиться, а истечь может только их срок действия. Сами сервис и сертификат истечь не могут.