Используя слово «вы» в руководстве пользователя [закрыто

Question

Я пишу руководство пользователя, и я пришел к обсуждению с коллегой. Он говорит, что не могу использовать слово «вы» в любом месте в руководстве. Теперь я помню что-то об этом в школе, но это не было для написания процедур. Также, делая некоторый гудящий, я заметил, что большинство учебников, где многое использовать. Я бы предпочел использовать его, но только если это считается хорошей практикой. что ты думаешь?

Answer 1

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

Answer 2

Альтернативы, о которых я знаю:

• «Вы» (второго лица единственного числа) - «Вы должны положить тарелку на стол».
• Императив - «поставить тарелку на стол».
• «Мы» (первый человек множественное число) - «Мы должны поставить тарелку на стол».
• «Пользователь» (третье лицо единственного числа) - «Пользователь должен поставить табличку на стол».
• Пассивный - «Тарелка должна быть нанесена на стол».

Мои собственные предпочтения:

• Я предпочитаю необходимый в качестве режима по умолчанию, потому что это самый короткий (наименьшей глагол).
• Я избегаю пассивного и первого лица множественного числа.
• Я использую местоимение второго лица («вы») или третье лицо существительное (например, «ваш системный администратор»), когда я хочу явную тему вместо императива.

Answer 3

Что легче понять?

Нажмите кнопку. Вы увидите диалоговое окно, где вы можете ввести свое имя.

или

Действие нажатия кнопки приведет к появлению диалогового окна, позволяющее пользователю ввести его или ее имя.

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

Answer 4

• Если ты Хотите, вы можете избежать своего стиля, написав в пассивном / императивном стиле. Вы также можете попробовать подход «Мы», но это может звучать немного по-детски. Вы не делаете ничего плохого в использовании вас, хотя.
• Избегать писать в своем стиле,использовать пассивный / императивный стиль. Мы-подход мощь также работай, Хотя это может звучать немного по-детски. Нет ничего плохого в использовании вас, хотя.
• Мы можно избежать письма в вашем стиле, используя пассивный / императивный стиль. Или мы могли бы использовать мы-подход, хотя мы могли бы звучать немного по-детски. Можно попробовать один подход, но риск звучал к жесткой верхней губе и отталкивает читателя. Мы Не против использования вас время от времени.

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

Answer 5

Вы должны писать объяснения третьего человека.

Модель Java Streams - это пример классического декоратора.

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

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

Теперь, как вы себя чувствовали после того, как вы издали вам 2 команда, мой читатель?

Answer 6

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

Answer 7

Я бы сделал то, что Google, Microsoft, Yahoo и т. Д. Вот страница произвольной помощи из Google:

http://mail.google.com/support/bin/answer.py?hl=en&answer=8494.

показывает, что «вы» используются. Вы можете проверить, как Microsoft также пишет свое руководство пользователя.

Как сбоку, я бы не использовал «я» или «мы».

Answer 8

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

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

Answer 9

Я бы сказал, просто будь осторожен. Это может столкнуться как слишком случайно. Если предполагаемая аудитория является Business-Y, я бы избежал этого. Однако, если это домашний сценарий пользователя или маркетинг, является случайным (думать, что юго-западные авиакомпании), я бы сказал, пойти с ним.

Просто не злоупотребляю. Тогда он становится налогом на читателю.

Образец того, как он предназначен для использования?

Answer 10

Все зависит от тона и стиля вашего письма. Формальные подходы препятствуют использованию «вы». Лично я люблю использовать стиль, который является кратным, к точке и относительно неформально. У меня нет проблем с словом «Вы», когда используется экономно.

Избегайте чрезмерного использования, как в:

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

Answer 11

Из справочника технического письма. 8-е издание (стр. 262):

Вы можете сделать предложения короткими, оставив некоторые статьи (A, An, The), некоторые местоимения (вы, это, эти), а некоторые глаголы, но такие предложения могут привести к телеграфному стилю и быть сложнее понять.

Итак, я бы сказал, что это нормально, чтобы использовать вас, но, как и Гилберт Ле Бланн сказал в своем комментарии, часто лучше писать », затем нажмите кнопку« вместо », затем вы нажмете кнопку«.

Answer 12

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