Использование слова «вы» в руководстве пользователя [закрыто]
Оператор == проверяет, указывают ли две ссылки на один и тот же объект или нет. .equals() проверьте фактическое содержимое строки (значение).
Обратите внимание, что метод .equals() принадлежит классу Object (суперкласс всех классов). Вам необходимо переопределить его в соответствии с вашим требованием к классу, но для String оно уже реализовано и проверяет, имеет ли две строки одно и то же значение.
- Случай 1
Причина: строка литералы, созданные без нуля, хранятся в пуле строк в области перментонов кучи. Таким образом, оба s1 и s2 указывают на один и тот же объект в пуле.String s1 = "Stack Overflow"; String s2 = "Stack Overflow"; s1 == s2; //true s1.equals(s2); //true - Случай 2
Причина. Если вы создаете объект String с использованием ключевого словаString s1 = new String("Stack Overflow"); String s2 = new String("Stack Overflow"); s1 == s2; //false s1.equals(s2); //truenew, ему выделяется отдельное пространство в куче.
11 ответов
Некоторые люди считают, что руководства следует писать так, как если бы они были научными статьями. Другие считают, что важнее техническая точность и удобочитаемость. Я придерживаюсь последнего убеждения - используйте «вы», если это соответствует вашему общему стилю, но будьте последовательны в своем использовании - я считаю, что документы, которые переключаются между «вы» и «мы», раздражают (и это грех, что я был виноват в себе).
Из Справочника по техническому письму. 8-е издание (стр. 262):
Вы можете сделать предложения короче, опуская некоторые артикли (a, an, the), некоторые местоимения (you, this, this) и некоторые глаголы, но такие предложения могут привести к телеграфным сообщениям. стиль и сложнее понять.
Я бы сказал, что вас можно использовать, но, как сказал Гилбер Ле Блан в своем комментарии, часто лучше написать «затем щелкнуть кнопку» вместо «затем щелкнуть кнопку».
Что легче понять?
Нажмите кнопку. Вы увидите диалоговое окно, в котором вы можете ввести свое имя.
или
Щелчок по кнопке вызовет появление диалогового окна, позволяющего пользователю ввести свое имя.
Первое понять гораздо легче. (Использование «вы» иногда может быть небрежным, но это имеет место в тех случаях, когда оно используется вместо «одного», «некоторых людей» или «людей в целом». Это нормально использовать там, где вы на самом деле относится к человеку, читающему текст.)
Альтернативы, которые я знаю:
- 'Вы' (второе лицо единственного числа) - "Вы должны поставить тарелку на стол."
- Императив - "Поставьте тарелку на стол."
- 'Мы' (первое лицо множественного числа) - "Мы должны поставить тарелку на стол. "
- 'The user' (третье лицо единственного числа) - "Пользователь должен поставить тарелку на стол."
- Passive - "Тарелку нужно поставить на стол."
Мои собственные предпочтения таковы:
- Я предпочитаю императив как способ по умолчанию, потому что он самый краткий (меньше слов).
- Я избегаю пассива и первого лица множественного числа.
- Я использую местоимение второго лица ("вы") или существительное третьего лица (например, "ваш системный администратор"), когда мне нужен явный субъект, вместо императива.
Вы должны писать объяснения от третьего лица.
Модель потоков Java является классическим примером шаблона декоратора.
Вы должны писать инструкции от второго лица, но даже в этом случае не рекомендуется называть читателя «вы».
Создайте конструктор, который может инициализировать списки на основе заданного списка списков.
Итак, как вы себя чувствовали после того, как я дал вам 2 команды, мой читатель?
Я бы сделал то, что делают Google, Microsoft, Yahoo и т.д. Вот случайная страница справки от Google:
http://mail.google.com/support/bin/answer.py?hl=en&answer=8494
показывает, что используется "вы". Вы также можете проверить, как Microsoft пишет свое руководство пользователя.
В качестве примечания, я бы не использовал "я" или "мы".
Technical Writing Обеспечьте соблюдение правила использования только пассивного текста. Это означает, что избегать «вас» будет хорошей идеей, чтобы оставаться в безопасности. это основано на том, как я это делаю лично.
Я бы сказал, будьте осторожны. Это могло показаться слишком случайным. Если целевая аудитория - деловая, я бы этого избегал. Однако, если это сценарий домашнего пользователя или маркетинг случайный (например, Southwest Airlines), я бы посоветовал пойти с ним.
Только не злоупотребляйте. Тогда это становится утомительным для читателя.
Пример использования?
Я думаю, если вы предоставляете императивы, такие как «Откройте дверь», или иным образом обращаетесь непосредственно к читателю, то вам следует использовать «вы» вместо того, чтобы заставлять себя труднее понять, говоря о каком-то абстрактном пользователе.
Даже в научных статьях, некоторых из самых формальных текстов, которые я могу придумать, остается спорным вопрос о том, допустимы ли я , мы и другие языки от первого лица. Как бы учителя грамматики в старших классах ни хотели, чтобы вы думали иначе, универсально подходящей схемы не существует.
Все зависит от тона и стиля вашего письма. Формальные подходы не поощряют использование "вы". Лично мне нравится использовать стиль, который является кратким, точным и относительно неформальным. У меня нет проблем со словом "вы", если оно используется экономно.
Избегайте чрезмерного употребления, например:
Когда вы хотите запустить приложение, вам нужно ввести пароль, а затем выбрать функцию, которую вы хотите использовать.
- Если вы хотите, вы можете избежать вы в стиле, написав в пассивный / императивный стиль. Вы можете также попробуйте подход «мы», но это может показаться немного по-детски. Вы не делаю ничего плохого в использовании тебя хотя.
- Чтобы не писать в стиле «вы», используйте пассивный / императивный стиль. В we-подход может также работать , хотя это может показаться немного детским. Там нет ничего плохого в том, чтобы использовать тебя хотя.
- Мы можем не писать в стиле "вы" используя пассивный / императивный стиль. Или мы могли бы использовать мы-подход, хотя мы могли бы звучать немного по-детски. Можно попробовать один подход, но рискуя звучать жесткая верхняя губа и отчуждение читатель. Мы не против использовать вас один раз через некоторое время, однако.
Я предпочитаю вторую строчку. За серией команд легче следовать, чем за рассказом в форме «вы».