技術トレーニングマニュアルの作成

事業主として、従業員または顧客向けの技術トレーニングマニュアルを作成する必要がある場合があります。自分でマニュアルを作成するか、知識のあるスタッフにプロジェクトを割り当てるか、請負業者に作成を外部委託するかを選択する場合でも、マニュアルの作成は、トレーニング資料を使用する人のニーズを満たすように特定のガイドラインに従う必要があります。 。

あなたの聴衆を特定する

執筆や調査を行う前に、誰がマニュアルを使用するかを特定してください。資料が顧客向けである場合、初心者向けに構成された指示が必要です。従業員向けのマニュアルを作成する場合は、資料を作成するときに、会社に固有のガイドラインを含める必要がある場合があります。たとえば、特定の製品にさまざまな機能がある場合でも、従業員をそれらのより小さなサブセットに制限し、トレーニングマニュアルにそれらの制限を含めることができます。

あなたの目的を決定する

対象者の基本的なプロファイルを作成したら、トレーニングマニュアルを作成する際の目的を決定します。一般に、技術トレーニングマニュアルは、製品の使用方法についてユーザーに段階的な指示を提供します。マニュアルの目的を決定するときは、単に基本的な指示を提供するか、製品の使用をより深く掘り下げるかを決定してください。たとえば、ソフトウェアの基本的な用途は手紙を書くことかもしれませんが、ニュースレターを作成するための追加の手順を含めることもできます。

ビジュアルを組み込む

ビジュアルは、技術トレーニングマニュアルの書面で説明されている手順をユーザーに案内するのに役立ちます。フローチャートまたは図は、テキスト内のステップのグラフィック表現を提供します。必要に応じて、写真または図面は、説明に記載されている製品の特定の機能をユーザーに示すことができます。たとえば、マニュアルでは、コンピュータをルーターに接続する方法についてユーザーに説明している場合があります。接続コードが取り付けられている場所を示す物理的なレイアウトのビジュアルは、書面による指示を補強します。

はっきりと書く

技術トレーニングマニュアルを作成する専門家として、言葉遣いを慎重に検討する必要があります。あなたが書くとき、ターゲットオーディエンスが持っている知識のレベルを考慮してください。トレーニングマニュアルが必要な場合は、おそらく製品についてあまり知らないでしょう。彼らはまた、あなたに自然に来る頭字語や業界用語を理解していないかもしれません。最初の使用時に各頭字語を説明し、専門用語を避けます。簡単な説明で手順を明確に説明します。論理的に別々のサブトピックに分割された章を作成します。サードパーティに指示をテストしてもらい、情報が明確であり、望ましい結果が得られることを確認します。