多くの場合、専門用語、頭字語、およびPh.Dが理解することを必要とする指示で満たされて、ソフトウェアのユーザマニュアルは時々ユーザよりもむしろ開発者の観点から書かれています。その結果、このガイドは読者のスキルレベルについてしばしば誤った仮定をするかもしれません。良いユーザーマニュアルを書くための最初のステップは、実際のライティングプロセスをできるだけエンジニアから遠ざけることです。
ソフトウェア開発者は、ソフトウェアを機能させるものを他の誰よりも知っていますが、それは開発者がガイドを書くべきであるという意味ではありません。それどころか、それは明らかに不利な点です。ソフトウェアの内部動作を深く理解することよりも重要なのは、エンドユーザーが誰になるのか、彼の学歴レベル、そしてそのエンドユーザーがソフトウェアをどのように使用するのかを理解することです。ほとんどの場合、エンドユーザーはプログラミングの細かい点やソフトウェアのバックエンドの動作を知る必要はありません - 仕事を容易にするためにそれを使用する方法を知る必要があるだけです。
ユーザーテスト
ユーザーマニュアルは、説明的なものではなく、主にタスク指向のものにしてください。マニュアルはユーザーが特定のタスクを実行する方法を理解するのを助けるように書かれているので、ライターは同様にそれらのタスクの理解を持つ必要があります、そしてその結果として、それぞれの機能の個々のステップを通すことは絶対に不可欠です。設計者または開発者の観点からプログラムがどのように作成されたかを作者が必ずしも知っている必要はありませんが、そのすべての機能に関する実用的な知識を持っていることが不可欠です。各タスクの実行中に、クリック、ドロップダウンメニュー、およびその他の操作を含め、すべてのステップを書き留めてください。
インタビュープロセス
開発者はマニュアルを執筆する人であるべきではありませんが、執筆者にとっては貴重な資料であり、執筆を始める前に、作家、開発者、エンジニア、および潜在的なエンドユーザーの間でキックオフミーティングを計画してください。最初から作家の仕事。主題の専門家やエンジニアへのインタビューを記録し、後で参照するためにトランスクリプトを作成する必要があります。
画像
ユーザーマニュアルはテキストが多すぎてはいけません。むしろ、グラフィックとスクリーンクリップの自由な使用を取り入れてください。アクションの説明は、その方向を明確に示すスクリーンクリップを伴うテキストベースの方向を使用すると、より明確になります。各アクションを実行する前に画面がどのように表示されるのか、およびアクションが実行された後に何が行われるのかを表示するには、ビューの前後に含めます。 Microsoft Windowsに含まれているSnipping Toolなどの単純な画面キャプチャユーティリティは、これらの画像をキャプチャするのに適しています。必ず各画像に番号を付け、簡単に説明するキャプションを付けてください。画像に示されている概念を最初に紹介する段落のすぐ下に配置します。
フォーマット
技術文書で明確に通信するには、ガイド全体を通して計画を立て、標準を慎重に順守する必要があります。表現、言語、および用語の両方における標準は、混乱を避けるのに役立ちます。テンプレートは利用可能であり、均一性の良い出発点になることができますが、これらは確かにそれぞれの状況に合うように適合させることができます。 1列で1インチの余白を使用すると、グラフィックを追加する必要性に最も適しています。 2列の設定では混雑しすぎて表示され、画像の配置がわかりにくい場合があります。
バージョン管理と追跡
他のどの種類の文書よりも、ソフトウェアのユーザーガイドは完成するまでに何度も繰り返し、また複数の利害関係者によるレビュープロセスを経ることになるでしょう。 Microsoft Wordの変更履歴の追跡機能を使用すると、各個人のコメントと変更を簡単に追跡できます。各レビューサイクルの後に、それぞれ異なるファイル名を使用して複数のバージョンを作成することも、プロセスの進行に役立ち、すべての関係者が最終結果に満足していることを確認します。
