Написание технической документации: как обращаться к «пользователю»

Question

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

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

Можно ли звонить пользователю - "это"

Как:

Запрашиваемая «это» для установки программного обеспечения. Попросить «его» установить программное обеспечение. Попросить «ее» установить программное обеспечение.

Пожалуйста, прости меня, английский не мой родной язык, но это должно быть сделано на английском языке.

Я спросил здесь, потому что многие из вас могли написать техническую документацию.

Answer 1

Хотя вы не хотите злоупотреблять этим, вы можете просто сказать «пользователь»

Например:

«Попросить пользователя установить программное обеспечение.»

Однако вы не хотите использовать это несколько раз в абзаце ... в противном случае чтение на английском расстраивает.

Обычно "он / он" нейтрален в гендерном отношении, однако, если вы нацелены на женщин, нет ничего плохого в использовании "она / ее"

НЕ используйте "это" !!!

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

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

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

Answer 2

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

"Чтобы отправить заказ, она должна нажать на кнопку ниже"

Теперь вы также можете ссылаться на пользователя словом «пользователь» или подобными словами, не используя его / ее.Чтобы избежать повторения, попробуйте найти другие слова, такие как "человек", "человек" и т. Д.

"Сначала посетитель должен добавить хотя бы один товарв корзину. Если корзина пуста, кнопка «Доставка заказа» будет отключена. человек может добавить до 1000 товаров. Обратите внимание, что клиент может прекратить или отменитьзаказ в любой момент. "

Будьте осторожны.Читатель документации должен понимать, что вы каждый раз говорите о одном и том же актере.Чтение требований, меня часто путают между клиентом , клиентом , посетителем и пользователем .Часто авторы этих требований предполагают, что посетитель и пользователь - это люди, которые используют веб-сайт, но customer или client являетсячеловек, который заказал сайт в нашей компании.

Если вы используете UML, вы также можете ссылаться на пользователя с помощью ярлыка, присвоенного пользователю на диаграмме акторов UML (в вашем случае это будет «Студент»?).

Answer 3

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

Answer 4

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

Answer 5

Иногда люди читают документацию для развлечения. Иногда они читают это, чтобы учиться. Чаще всего они читают это, потому что они застряли. Тогда вы можете просто поговорить с ними. Вы можете использовать базовый шаблон:

Сформулируйте проблему как факт или вопрос. Чтобы решить эту проблему, сделайте следующее: 1. Откройте ваш браузер 2. Нажмите на кнопку 3. Введите некоторую информацию

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

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

Answer 6

Термин пользователь сегодня достаточно универсален, поэтому его стоит использовать.На самом деле есть книги на эту тему.

Читайте: "Руководство пользователя" Майкла Бремера

Answer 7

Для общей документации часто пишется «пользователь». Например, «Попросить пользователя установить программное обеспечение». В этом нет ничего плохого. Пользователь не относится к конкретному полу, поэтому он работает хорошо.

Тем не менее, вы упоминаете, что нацелены на студенток с этим проектом Исходя из этого, использование женских терминов во всем имеет смысл.

Answer 8

Что не так с использованием "пользователя"? Т.е. «Попросить пользователя установить программное обеспечение». Это совершенно правильная конструкция.

Answer 9

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

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