§3 説明書(マニュアル・ドキュメント)の作成 VB6
  前へ 目次へ 次へ 

 電流、電圧、抵抗を求めるオームの法則ツールの説明書を書く。
 基本的には、このソフトウェアができる事柄についてすべてを説明することが必要である。ただし、すべてを羅列してもわかりにくいものとなってしまうので、ある程度、項目ごとにまとめて書くことが必要である。また、図や写真なども利用して誰にでもわかりやすいものとなるように心がけなければならない。
 次に、大まかな項目の例を示す。

  1. 概要
    ・ソフトウェア(ツール)のできることや特徴など、アピールできることを書く。
     簡単な操作で電流・電圧・抵抗の計算ができる。 など
  2. インストール方法
    ・ソフトウェアを使えるようにするための手順や注意事項を説明する。
    ・インストール中、インストール後に設定が必要な場合はそれについても説明する。
    ・アンインストールの方法なども説明しておくと丁寧である。
  3. 起動・終了方法
    ・起動するためのメニュー選択方法などについて説明する。
    ・終了する方法や終了するときに注意すべきことなどがあれば説明する。
  4. 操作方法
    ・起動後のソフトウェアの使い方を説明する。
    ・ソフトウェアのできること(機能)についての操作方法を漏れのないように説明する。
  5. その他
    ・ソフトウェア使用上の注意事項、使用許諾契約、など必要に応じて説明を補足する。

 マニュアルの作成には、日本語ワープロなどのアプリケーションを使うので、使用方法(文字や図の入力方法、ページの設定方法、文書の保存や印刷の方法など)を知り、活用できるように学習しておく必要がある。ソフトウェア開発であってもプログラミングだけではないので、コンピュータ全般についての幅広い知識と作成しようとするソフトウェアで必要とされる仕事内容など、知識を広めておく必要がある。ソフトウェアで必要とされる仕事内容とは、例えば、今回制作したオームの法則ツールであればオームの法則に関する知識のことである。


説明書の例

 
オームの法則計算ツール
 
1.概 要
 
 本ツールはオームの法則にしたがって、電流、電圧、抵抗の値を計算するソフトウェアです。一つのウィンドウで、計算したい種類(電流、電圧、抵抗)を選ぶと、その計算に必要なデータ項目が表示されるようになっています。
 計算したい種類を入力したあとは、データ入力、計算開始などはキーボードだけで操作することができます。
 
2.インストールの方法
 
 セットアップ用のDisk1を挿入し、Setup.exeを実行します。セットアップウィザードが起動し、必要なファイルがハードディスクにコピーされます。途中で、ディスクの交換を要求するメッセージが表示されますので、Disk2に交換してください。
 
3.起動と終了方法
 
 本ツールを起動するには、スタートボタンをクリックし、メニューから次のように選択します。
 
    [スタート] → [プログラム(P)] → [オーム] → [オームの法則]
 
 終了するときは、終了ボタンをクリックしてください。
 
4.操作方法
 
(1) 計算する種類をマウスで選択します。@
 電流を選択すると、左図のようにAの位置のメッセージが計算に必要な電圧と抵抗になります。
 同じように、電圧を選択すると電流と抵抗に、抵抗を選択すると電圧と電流にメッセージが変わります。
 
(2) Aの位置に計算に必要な数値を2つ入力します。
 
(3) 計算開始ボタンをクリックすると、計算結果がBの位置に表示されます。2つ目の数値入力後、Enterキーを押すとCの計算開始ボタンにフォーカスが移動しますので、もう一度Enterキーを押せば結果が表示されます。
 
(4) 入力データを消すためにはDのクリアボタンをクリックします。
 
5.補足事項
 
 Enterキーやクリックをすると、Aのデータ入力 → Cの計算開始 → A の順にフォーカスが移動しますので、計算する種類を選択したあとは、キーボードだけで操作することができます。
 
 
XXX ○×△ソフトウェアシステム
(個人名・会社名、連絡方法など)

 ここで示した説明書例はあくまでもサンプルであり、これで良いというものではない。例えば、「2.インストールの方法」ではインストール中の画面の図を入れるなどわかりやすくするための工夫の余地はある。
 わかりやすくするためとはいえ、ページ数が多くなっては読む(見る)だけでも大変であるし、製品にする場合などは費用(コスト)的にも問題となるので、バランスが必要である。

 ソフトウェア製品やフリーソフトなどに付いてくる説明書(ドキュメント)などで、どのような事柄について、どのように書かれているか、というような観点で見るようにしてみよう。


  前へ 目次へ 次へ 
Copyright © 2001,2002 Hiroshi Masuda 

 

 

inserted by FC2 system