マニュアルの書き方
マニュアルと一口にっても、その種類は多種多様です。
例えば、ソフトウェア関連のマニュアルを作成する場合、
パソコンのアプリケーションプログラムや情報機器の
操作方法などを記載する必要があります。
ソフトウェア関連のマニュアルでは、
大きくユーザ向けドキュメントと、
保守用ドキュメント、開発用ドキュメントと
３つの種類に分類されます。
なかでもユーザ向けドキュメントは、お客様が一番よく
参照するドキュメントになるので、
用語の統一、開発用語を使わない、など
エンドユーザー視点でのドキュメント作成を求められます。
ユーザ向けドキュメントとして用意するものには、
・導入手引書（導入ガイド）
・操作マニュアル
・リファレンス（辞書）
・事例集
・セットアップ・インストールガイド等
があります。
導入的美書では、まずはソフト全体の概要を記載し、
操作マニュアルでは各機能の詳細について述べる必要があります。
各マニュアルの役割を明確にした上で、
ドキュメントを作成することが重要です。
|
|
コンテンツ
関連サイト
お勧めサイト
|
