Использование слова "ты" в руководстве пользователя
Я пишу руководство пользователя и вступил в дискуссию с коллегой. Он говорит, что я не могу использовать слово "ты" где-либо в руководстве. Теперь я помню кое-что об этом в школе, но это было не для написания процедур. Кроме того, занимаясь поиском, я заметил, что в большинстве уроков он часто используется. Я бы предпочел использовать его, но только если это считается хорошей практикой. что ты думаешь?
12 ответов
Некоторые люди считают, что руководства должны быть написаны так, как если бы они были научными работами. Другие считают, что техническая точность и удобочитаемость важнее. Я придерживаюсь последнего убеждения - используйте "вы", если оно соответствует вашему общему стилю, но будьте последовательны в вашем использовании - я нахожу документы, которые переключаются между "вами" и "мы", раздражают (и это грех, я был виновен в себе).
Альтернативы, которые я знаю:
- "Вы" (второе лицо единственного числа) - "Вы должны поставить тарелку на стол".
- Императив - "Поставь тарелку на стол".
- "Мы" (от первого лица во множественном числе) - "Мы должны поставить тарелку на стол".
- "Пользователь" (третье лицо единственного числа) - "Пользователь должен поставить тарелку на стол".
- Пассив - "Тарелка должна быть на столе".
Мои собственные предпочтения:
- Я предпочитаю императив в качестве режима по умолчанию, потому что он самый короткий (меньше всего словоблудия).
- Я избегаю пассивного и первого лица во множественном числе.
- Я использую местоимение от второго лица ("вы") или существительное от третьего лица (например, "ваш системный администратор"), когда мне нужен явный предмет вместо императива.
Что легче понять?
Нажмите на кнопку. Вы увидите диалоговое окно, где вы можете ввести свое имя.
или же
Нажатие на кнопку приведет к появлению диалогового окна, в котором пользователь сможет ввести свое имя.
Первое намного легче понять. (Использование "вы" может иногда быть небрежным, но это имеет место в тех случаях, когда оно используется вместо "один", или "некоторые люди", или "люди в целом". Хорошо использовать его там, где вы на самом деле ссылаясь на человека, читающего текст.)
- Если вы хотите, вы можете избежать стиля вы, написав в пассивном / императивном стиле. Вы также можете попробовать подход "мы", но это может звучать немного по-детски. Вы не делаете ничего плохого в использовании вас, хотя.
- Чтобы не писать в стиле "я",используйте пассивный / императивный стиль. Подход "мы" может также работать, хотя может показаться немного детским. Там нет ничего плохого в использовании вас, хотя.
- Мы можем избежать написания в стиле "ты", используя пассивный / императивный стиль. Или мы могли бы использовать наш подход, хотя мы могли бы звучать немного по-детски. Можно было бы попробовать один подход, но рискнул бы звучать до предела и оттолкнуть читателя. Мы не против использовать вас время от времени.
Я сам предпочитаю вторую строчку. За последовательностью команд легче следовать, чем за историей в своей форме.
Вы должны писать объяснения от третьего лица.
Модель потоков Java является классическим примером шаблона Decorator.
Вы должны написать инструкции от второго лица, но даже тогда не следует называть читателя "вами".
Создайте конструктор, который может инициализировать списки на основе заданного списка списков.
Теперь, как вы себя чувствовали после того, как я дал вам две команды, мой читатель?
Техническое письмо Обеспечить соблюдение правила использования только пассивного текста. а это значит, что избегать "вы" будет хорошей идеей, чтобы оставаться в безопасности. это основано на том, как я делаю это лично.
Я думаю, что если вы предоставляете императивы, такие как "Открой дверь", или иным образом напрямую обращаетесь к читателю, то вам следует использовать "вы" вместо того, чтобы усложнять себе понимание, говоря о каком-то абстрактном пользователе.
Даже в научных работах, некоторые из наиболее формального письма я могу думать, это спорно я,мы и другие первый язык является ли человек или не допускается. Как бы вы ни хотели, чтобы учителя грамматики в старших классах школы думали иначе, универсальной схемы не существует.
Я бы сделал то, что делают Google, Microsoft, Yahoo и т. Д. Вот случайная страница справки от Google:
http://mail.google.com/support/bin/answer.py?hl=en&answer=8494
показывает, что "вы" используется. Вы также можете проверить, как Microsoft пишет их руководство пользователя.
В качестве примечания я бы не использовал "я" или "мы".
Все зависит от тона и стиля вашего письма. Формальные подходы препятствуют использованию "вы". Лично мне нравится использовать стиль, который является лаконичным, точным и относительно неформальным. У меня нет проблем со словом "ты", когда оно используется экономно.
Избегайте чрезмерного использования, как в:
Если вы хотите запустить приложение, вы должны ввести свой пароль, а затем вы должны выбрать функцию, которую вы хотите использовать.
Из справочника технического письма. 8-е издание (стр. 262):
Вы можете сделать предложения короче, пропустив некоторые статьи (a, an, the), некоторые местоимения (вы, это, эти) и некоторые глаголы, но такие предложения могут привести к телеграфному стилю и их будет труднее понять.
Итак, я бы сказал, что можно использовать вас, но, как сказал Гилберт Ле Блан в своем комментарии, часто лучше написать "затем нажать кнопку", а не "затем нажать кнопку".
Безличная форма должна быть предпочтительной. Использование "вы" было бы слишком ясным, и большинство ваших клиентов будут считать, что вы не профессионал. Четкое руководство также уменьшит потребность в поддержке клиентов после продажи и приведет к убыткам для компании.
Я бы сказал, просто будь осторожен. Это может показаться слишком случайным. Если предполагаемая аудитория деловая, я бы этого избегал. Однако, если это сценарий для домашнего пользователя или маркетинг случайный (например, Southwest Airlines), я бы сказал, пойти с ним.
Просто не злоупотребляйте. Тогда это становится налогом для читателя.
Пример того, как он предназначен для использования?