まず、ソフトウェアのユーザーマニュアルを英語で作成する投稿から始めます。 ユーザーヘルプは、ソフトウェア製品の重要なコンポーネントです。 証明書を作成するには、特別な注意が必要です。 その中のエラーや理解できない文言は、しばしばプログラム自体の欠陥として認識され、製品の印象を台無しにします。 ジャーナリストは、不十分な書面または翻訳されたヘルプをレビューの欠如として言及し、ユーザーはルーブルで投票します-マニュアルの指示に問題があるか理解していない場合、トライアルを登録することはほとんどありません。 一方、よく翻訳されたヘルプを備えたプログラムは販売が容易です。
この投稿では、ユーザーのヘルプで英語で発生する可能性のあるいくつかのエラーと、それらを回避する方法について説明します。 これらの推奨事項は網羅的なものではありません。 既にガイドされているルールと一緒に使用することは理にかなっています。
では、ユーザーヘルプにはどのような種類のエラーがよく見られますか？
1.手順の不合理な説明
手順の説明では、情報はユーザーによる認識に関して最も合理的な方法で配置する必要があります。 つまり、最初にユーザーがアクションを実行する場所を指定し、次にユーザーが実行する操作（クリック、開く、選択）を指定します。
例：
誤り：[ファイル]メニューから[開く]を選択します。
正しい例：[ファイル]メニューで[開く]を選択します。
2. 1つの文に複数の手順を記録する
ヘルプ作成者は、しばしば複雑な手順を1つの文で説明しようとします。 説明を明確にするためには、長い文をステップに分割する必要があります。
例：
間違った：
ディストリビュータのタイプを選択するには、[作成]ボタンをクリックすると、フローティングウィンドウが開きます。
正しく：
ディストリビュータの種類を選択するには、次の手順を実行します。
1. [作成]ボタンをクリックします。
2.「作成」ウィンドウで、ディストリビューターのタイプを選択します。
3. [OK]をクリックして、選択を保存します。
3.ステップの誤った定義
複雑な手順は、いくつかのステップで構成されています。 各ステップにはアクションとその結果が含まれている必要があります。 ただし、多くの場合、アクションと結果の両方が別々の手順として表示される説明があります。 これは間違っています。
例：
間違った：
1. [電話帳]タブを選択します。
2. [電話帳]ウィンドウが開きます。
3.連絡先をクリックします。
4.連絡先プロファイルが開きます
正しく：
1. [電話帳]タブを選択します。
電話帳ウィンドウが開きます。
2.連絡先をクリックします。
連絡先プロファイルが開きます。
または：
1. [電話帳]タブを選択します。
2. [電話帳]ウィンドウで、連絡先をクリックします。
4.引用符で囲まれたボタンの名前
ユーザーヘルプでは、ボタンの名前が引用符で囲まれていることがよくあります。 ただし、タイプライターが引用符とアンダースコア以外のテキストをフォーマットする方法を持たなかったとき、多くはこれを過去の遺物と考えています。 ボタンの名前は、小さな大文字または太字で書くのが最善です。
例：
間違った：「削除」ボタンはリストからファイルを削除します。
正しい例：[削除]ボタンは、リストからファイルを削除します。
正しい例：[ 削除 ]ボタンは、リストからファイルを削除します。
ちなみに、ボタンの名前のつづりで間違った単語の順序を見つけることがあります。ボタンの名前は「ボタン」という単語の後に書かれています。
例：
間違った：[新規]ボタンをクリックすると、新しいトランザクションが開始されます。
正しい例：[新規]ボタンをクリックすると、新しいトランザクションが開始されます。
5.および/または
「and / or」の組み合わせを使用しないでください。 テキストの認識が複雑になり、ユーザーは文を再度読み直す必要があります。 「and / or」の代わりに「... or ... or both」を使用します。
例：
間違った：ファイルをAVIやMP3に変換できます。
正しい例：ファイルをAVIまたはMP3、あるいはその両方に変換できます。
6.用語の誤用
経験の浅い著者は、用語の使用を間違えることがよくあります。
例：
間違った例：[新規]アイコンを押して、新しいプロジェクトを作成します。
右：[新規]アイコンをクリックして、新しいプロジェクトを作成します。
「押す」という動詞は、キーボード上のキーを押すことを意味し、「クリック」は、マウスのクリックでプログラムウィンドウのボタンまたはアイコンをクリックすることを意味します。
7.未来形
多くの場合、ユーザーのアクションに対するプログラムの応答が未来形で送信されるという説明があります。 たとえば、「OKボタンをクリックすると、プログラムは変換を開始します」。 これは完全に正しいわけではありません。 未来の時制により、読者は不必要な質問をすることを余儀なくされます。「変換はいつ始まるのですか？」、「変換が開始されない場合はどうなりますか？」 とても簡単です。
動詞「will」は、現在時制を表現するために使用されており、元々は「willan」という形をしており、意志の欲求や表現を表現するモーダル動詞でした。 人々が将来の計画について語るときに「ウィラン」が使われることがありました。 古い英語では、未来を伝える特別な形式はありませんでした。 時間が経つにつれて、「willan」は「will」になりましたが、それでも意志の意味合いを保持しています。 たとえば、意志の表現の意味は、「ペンは書かない」というフレーズでトレースされます（ロシア語-「ペンは書きたくない」）。
したがって、「OKボタンをクリックすると、プログラムは変換を開始します」という文を読むと、動詞「will」は未来だけでなく、意志の表現のモーダルな意味も表します。 結局のところ、プログラムは変換を開始したいのです。 また、「したくない」場合は、現在の時制を使用して、手順の説明があいまいにならないようにします。
間違った例：[OK]ボタンをクリックすると、プログラムが変換を開始します。
正しい例：[OK]ボタンをクリックすると、プログラムが変換を開始します。
8.専門用語
ユーザーヘルプスタイルは中立である必要があります。 スタイリストのように色付けされた単語を使用すると、ユーザーの注意をそらすことになり、避けるべきスタイル上の誤りです。
間違った：アプリを強制終了します。
正しい例：アプリケーションを閉じます。
間違った：検索ボタンを押してください。
正しい例：[検索]ボタンをクリックします。
9.略語
ユーザーヘルプは、略語や頭字語を避ける必要があります。
例：
間違った：約。
正解：およそ
間違った例：
正しい例：
例外は「など」のみです。
複数の単語の名前は、テキストで1回だけ使用される場合は省略しないでください。 ただし、それが複数回使用される場合は、本文の最初の言及で、フルネームと略語を括弧で囲む必要があります。 さらに本文では略語を使用します。
例：
正しく：
Oxygen Softwareは本日、NokiaおよびVertuの携帯電話向けにOxygen Phone Manager II（OPM II）の拡張バージョンを導入します。 OPM IIの最大の変更点は、Nokiaの革新的なSeries 40 5th Editionの品質サポートがテストされたことです。
ヘルプを書くときは、明快さ、正確さ、簡潔さのために努力しなければなりません。 推奨事項がユーザーガイドの作成に役立つことを願っています。