Клуб технических писателей

февраль 2017
О слове «требуемый»
Кирилл Богатов
6 февраля, 07:59

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

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


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

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

Возьмем какую-нибудь часть мануала и «развернем» её с учетом контекста:


Введите требуемое значение параметра в поле «Количество».

Чтобы оформить заказ, укажите количество товара. Для этого введите требуемое значение параметра в поле «Количество». Не пытайтесь вводить в это поле свои инициалы или дату рождения, т. к. это приведет к ошибкам в отчете.

Похоже на инструкцию для умственно отсталых.

В контексте задачи все значения являются требуемыми. Разумеется, если не сказано обратное:

Введите соответствующее значение из Таблицы 1.
Введите произвольное значение.


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

В настоящее время я еду в маршрутке.

Я еду в маршрутке.


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

Введите значение в поле «Количество».


Чтобы сделать предложение более плавным, его можно  перефразировать или уточнить:

Заполните поле «Количество».
В поле «Количество» введите количество товара в учетных единицах измерения.

Слово «требуемый»  не является уточнением:

— Введите значение.
— Какое значение?
— Требуемое.
— А какое значение мне требуется?
— Количество товара.


Введите количество товара.


А как вы относитесь к слову «требуемый»? Сталкиваетесь ли с другими стоп-словами?

3 комментария
стиль
Февральская встреча Сообщества технических писателей Санкт-Петербурга - 10 февраля 2017
Salangin
6 февраля, 07:59

Пятница, 10 февраля 2017, SEMrush, с 19 до 21 ч. Приглашаем на очередную встречу технических писателей. Основная тема — Документация в мобильной разработке. Кроме того, в ходе Lean cafe техрайтеры нашего города расскажут о своих достижениях, поделятся секретами и обменяются опытом.

Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Пришлашаем вас встретиться в SEMrush и поздравить друг друга 10 февраля, в пятницу.

В программе:

  • Lean Cafe «Знакомство, новости, ресурсы» (с 19 ч.)
  • Перерыв (у вас будет возможность получить рекомендации по профессиональному развитию, поделиться своими проблемами, обсудить ситуацию на трудовом рынке и поспорить о роли писателей в меняющемся мире IT)
  • Круглый стол «Документация в мобильной разработке» (с 20 ч.). Мы обсудим вопросы:
    • Какие новые термины должен знать техрайтер?
    • Необходимо ли техническое задание на мобильное приложение?
    • Каким может быть туториал в мобильном приложении?
    • Что писать в справке о приложении?
    • Будут ли пользователи читать сопроводительную документацию?
    • Как организовать пополнение FAQ?
    • Где найти информацию о разработке для iOS и Android?

Мероприятие бесплатное. Печеньки, чай и кофе — для вас.

Инфо и регистрация:
— на Timepad.ru: https://tw.timepad.ru/event/441497 
— на Meetup.com: http://meetu.ps/368fQ5 и приходите в любое время с 19 до 21.

Где: SEMrush, станция метро «Ладожская», улица Якорная, дом 7, БЦ «Анкор»

Как доехать: доехать до метро «Ладожская», выйти и повернуть налево, пройти 270 м до остановки трансфера SEMrush (микроавтобус с табличкой «SEMrush» на боковой двери).
Остановка трансфера находится: угол Гранитной улицы и Уткина переулка (около стрительного забора).
Автобус отправляется каждые 20-25 минут, начиная с 18 ч. (18-00, 18-20 и далее).

По всем вопросам звоните мне, Станиславу Салангину: +7(911)958-18-21 
или пишите в наши группы в соцсетях:

Следите за новостями в наших группах!

О Сообществе технических писателей Санкт-Петербурга:

Цель сообщества — создание и развитие открытой среды для профессионального общения, обмена опытом и роста. Сообщество работает в Санкт-Петербурге четвертый год. Его члены принимают участие в IT Global Meetup-ах, конференциях «Гипербатон». Организуются встречи с другими IT-сообществами. Приглашаем вступать в наши группы в соцсетях, участвовать в наших встречах, выступать на митапах.

2 комментария
Санкт-Петербург,СПб,техписатель,обмен знаниями,обучение,События,мобильные приложения,семинары,сообщество