«Воспользуйтесь переключателем...»

Продолжаем искать косяки в документации к гос. проекту.

Для публикации/снятия с публикации записи в строке с нужной записью воспользуйтесь переключателем «Публикация».

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

Как исправить

1. Исправим отглаголенное «Для публикации/снятия с публикации» на оборот с глаголом: «Чтобы опубликовать или снять с публикации».
2. Заменим абстрактное «воспользуйтесь» на более конкретное «щелкните». Это типовое действие, указанное в Microsoft Style Guide.
3. Переместим «в строке с нужной записью» в конец предложения, чтобы обозначить его связь с переключателем, а не публикацией. Также избавимся от слова «строка» — это лишняя сущность в мире интерфейса. Напишем, что переключатель находится напротив нужной записи.

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

Результат
Чтобы опубликовать или снять запись с публикации, щелкните переключатель «Публикация» напротив нужной записи.

«Браузер» или «Веб-браузер»?

Периодически встречаю в документации к гос. проектам слово «веб-браузер». Не надо так.

В англоязычной документации принят термин web browser (веб-обозреватель). Почему не просто browser?</div>
Кембриджский словарь подсказывает, что слово browser также может означать человека, который что-то просматривает (например, книги или товары). В этом случае приставка web- используется для уточнения, так как оба значения слова могут употребляться в схожем контексте.

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

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

Техническое задание по ГОСТ 34. Показатели назначения

Показатели назначения — один из самых мутных разделов технического задания. Вот что о нем пишут в ГОСТ 34:

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

Что же писать на самом деле — не понятно. Как правило всё сводится к одному из трёх вариантов:


  1. Ничего не писать. Воспользуемся тем, что разделы можно вставлять или удалять по собственному желанию.

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

  3. Ограничиться общими фразами.

Collapse )

Координатно-указательное устройство

Иногда в документации для государственных заказчиков встречаются вот такие «приветы из прошлого»:

Технические характеристики персональных компьютеров пользователей:
— Координатно-указательное устройство – манипулятор типа «мышь»;
— Клавиатура – не менее 104 клавиш (русифицированная).

Будто попал в СССР на курсы обучения основам работы с ЭВМ.

Сегодня не нужно объяснять пользователю, что такое мышь или сколько сколько клавиш должно быть на клавиатуре. Возможно, техпис решил схалтурить и скопировал текст из какого-то старого документа, чтобы всё выглядело официально и по ГОСТу. Вот только официальность эта никак не поможет читателю разобраться в документе.

Если что-то очевидно даже ребенку — не пишите.


Как изменить текст на сайте для скриншота

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

Такую информацию можно размыть с помощью инструмента Blur, но результат выглядит грязно. Кроме того, пользователь не сможет увидеть, в каком формате нужно вводить данные.

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

Collapse )

О слове «требуемый»



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

Введите требуемое значение параметра

Контекст
Многие думают, что если убрать слово «требуемый», то пользователи начнут вводить всё подряд. На самом деле, нет.Collapse )

Разбор ошибок. Затруднения с вводом

Оригинал

Введите числовое значение уровня движения. Если затрудняетесь с вводом, оставьте значение по умолчанию.

Пояснение

У меня нет проблем с вводом — руки на месте, клавиатура работает. А вот с выбором подходящего значения могут возникнуть проблемы.

Как исправить

Если вы затрудняетесь с выбором уровня, оставьте значение по умолчанию.

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


«Компания» или «кампания»?


Некоторые люди путают слова «кампания» и «компания», во всех случаях пишут через «о». На самом деле это два разных слова.

Компания
Компания – это группа людей или организация.

Каждый вечер наша компания отправляется в ближайший паб.
Наша компания ищет бармена и официанта.

Компания - это люди

Кампания
Кампания – это совокупность мероприятий или военных операций.

Рекламная кампания по продвижению нового товара прошла успешно.
В ходе военной кампании были захвачены стратегически важные объекты противника.
Кампания - это мероприятия


А какие слова вызывают трудности у вас?