ドキュメント - システム開発メモ

ドキュメントの種類

(予定)

ドキュメントの書き方

どのような文書が必要か

プログラムを単に使用するだけの者の為にも以下のような文書が必要となる。

プログラムを使用するために

1. 目的
   主要な機能、このプログラムを書く理由は何か(プログラムの必要性)。
2. 環境
   実行可能な機械、ハードウェア構成およびオペレーティングシステム構成。
3. 領域と範囲
   どの入力領域が有効に処理されるか。また、規則通り出力される出力範囲はどこか。
4. 実現される機能と使用されるアルゴリズム
   要するに、何をするものなのか。
5. 入出力フォーマット
   詳細かつ完全に。
6. オペレーション指示
   コンソールや出力リストに出力されるもので、正常時および異常時の終了処理を含む。
7. オプション
   機能に関して利用者にはどのような選択が出来るか。また、その選択の正確な指示方法。
8. 実行時間
   指定された構成で指定されたサイズの業務を処理するには、どのくらいの時間が掛かるのか。
9. 精度および検査
   出力結果にはどのくらいまでの精度が求められるのか。精度を検査するためのどんな手段が組み込まれているのか。

こうした情報は、往々にして三ページか四ページで全部説明できてしまうものだ。それには簡潔さと的確さに十分注意を払わなければならない。こういった文書のほとんどが、プログラムを書き始める前に下書きされる必要がある。というのも、それが基本的なプランを決定するのを具体的に示しているからだ。

当然、環境や目的の変更の為に改良しなければならない者には、より詳細な記述が必要となる。