documentation - ユーザーマニュアルで「あなた」という言葉を使用する

Question

私はユーザーマニュアルを書いていて、同僚と話し合っています。彼は、私がマニュアルのどこにも「あなた」という言葉を使うことができないと言います。今、私は学校でこれについて何かを覚えていますが、それは手順を書くためではありませんでした。また、グーグルを実行すると、ほとんどのチュートリアルでそれを頻繁に使用していることがわかりました。私はそれを使用したいと思いますが、これが良い習慣であると考えられる場合に限ります。どう思いますか？

score 20 · Accepted Answer

私が知っている代替手段は次のとおりです。

'You' (二人称単数) - 「お皿をテーブルの上に置いてください。」
必須 - 「皿をテーブルの上に置きます。」
'We' (一人称複数形) - 「皿をテーブルの上に置くべきです。」
'The user' (三人称単数) - 「ユーザーはプレートをテーブルに置くべきです。」
パッシブ - 「お皿はテーブルの上に置くべきです。」

私自身の好みは次のとおりです。

私は命令形をデフォルトのモードとして好んでいます。
私は受動態と一人称複数を避けます。
命令の代わりに明示的な主語が必要な場合、私は二人称代名詞 (「あなた」) または三人称名詞 (例えば、「あなたのシステム管理者」) を使用します。

score 16 · Accepted Answer

マニュアルは科学論文のように書かれるべきだと考える人もいます。技術的な正確さと読みやすさがより重要であると考える人もいます。私は後者の説得力を持っています - あなたの全体的なスタイルに適合する場合は「あなた」を使用しますが、使用法に一貫性を持たせてください - 「あなた」と「私たち」を切り替える文書はイライラします (そしてそれは私が犯した罪です)自分に罪がある）。

score 5 · Accepted Answer

どちらが分かりやすいですか？

ボタンをクリックします。名前を入力できるダイアログボックスが表示されます。

また

ボタンをクリックすると、ダイアログボックスが表示され、ユーザーが自分の名前を入力できるようになります。

最初の方がはるかに把握しやすいです。（「you」の使い方が下手な場合もありますが、「one」や「some people」、「people in general」などの代わりに使われる場合が多いです。実際にいる場所で使っても問題ありません）テキストを読んでいる人を指します。）

score 4 · Accepted Answer

必要に応じて、受動的/命令的なスタイルで書くことで、あなたスタイルを避けることができます. 'we' アプローチを試すこともできますが、それは少し幼稚に聞こえるかもしれません。しかし、あなたはあなたを使うことに何の問題もありません。
あなたスタイルで書くこと を避けるために、受身/命令スタイルを使用してください。少し幼稚に聞こえるかもしれませんが、we -approachも機能する可能性があります。あなたを使っても何も問題はありません。
受身/命令スタイルを採用することで、あなたスタイルで書くことを避けることができます。または、少し幼稚に聞こえるかもしれませんが、we-approach を使用することもできます。1 つのアプローチを試すこともできますが、上唇がこわばり、読者を遠ざけるリスクがあります。ただし、たまに使用することは問題ありません。

私自身は2行目を好みます。一連のコマンドは、you 形式のストーリーよりも簡単に理解できます。

score 3 · Accepted Answer

三人称で説明を書くべきです。

Java ストリームモデルは、古典的な Decorator パターンの例です。

指示は二人称で書くべきですが、それでも読者を「あなた」と呼ぶのは得策ではありません。

指定されたリストのリストに基づいてリストを初期化できるコンストラクターを作成します。

さて、読者の皆さんに 2 つのコマンドを発行した後、どのように感じましたか?

score 2 · Accepted Answer

テクニカルライティングパッシブテキストのみを使用するルールを適用します。つまり、「あなた」を避けることは、安全な側にとどまるための良い考えです. それは私が個人的に行う方法に基づいています。

score 1 · Accepted Answer

私はグーグル、マイクロソフト、ヤフーなどがすることをします。これがGoogleのランダムなヘルプページです。

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

「あなた」が使用されていることを示します。Microsoftがユーザーマニュアルをどのように書いているかも確認できます。

ちなみに、「私」や「私たち」は使いません。

score 1 · Accepted Answer

「ドアを開けてください」などの命令を提供している場合、または読者に直接話しかけている場合は、抽象的なユーザーについて話すことで自分自身を理解しにくくするのではなく、「あなた」を使用する必要があると思います。

私が考えることができる最も正式な文章のいくつかである科学論文でさえ、私、私たち、および他の一人称言語が許容されるかどうかについては議論の余地があります. 高校の文法教師は、あなたに別の考え方をしてほしいと思うかもしれませんが、普遍的に適切なスキームはありません。

score 0 · Accepted Answer

それはすべてあなたの文章のトーンとスタイルに依存します。正式なアプローチでは、「あなた」の使用を思いとどまらせます。個人的には、簡潔で、要領を得て、比較的非公式なスタイルを使用するのが好きです。控えめに使っても「あなた」という言葉は問題ありません。

次のように過度の使用を避けてください。

アプリケーションを起動するときは、パスワードを入力してから、使用する機能を選択する必要があります。

score 0 · Accepted Answer

非人称的な形式を優先する必要があります。「あなた」の使い方が明確すぎるため、クライアントのほとんどは、あなたが専門家ではないと考えるでしょう。また、明確なマニュアルは、販売後の顧客サポートの必要性を減らし、会社に損失をもたらします。

score 0 · Accepted Answer

気をつけてください。カジュアルすぎると思われるかもしれません。対象読者がビジネス関係であれば、私はそれを避けます。ただし、それがホームユーザーのシナリオであるか、マーケティングがカジュアルである場合 (Southwest Airlines を考えてみてください)、私はそれを採用することをお勧めします。

使いすぎないでください。すると、読み手に負担がかかります。

使用方法のサンプルは?

score 0 · Accepted Answer

テクニカルライティングハンドブックより。第 8 版 (p. 262):

一部の冠詞 (a、an、the)、一部の代名詞 (you、this、thes)、および一部の動詞を省略して文を短くすることはできますが、そのような文は電信スタイルになり、理解しにくくなる可能性があります。

したがって、あなたを使用しても問題ないと思いますが、Gilbert Le Blanc がコメントで述べたように、「ボタンをクリックしてから」ではなく「ボタンをクリックして」と書くほうがよい場合がよくあります。

documentation - ユーザーマニュアルで「あなた」という言葉を使用する

12 に答える 12

Related