福島県教育センター所報ふくしま No.21(S50/1975.6) -020/025page
データ処理におけるドキュメントDocument(文書)
〜そしてドキユメンテーションDocumentation(文書調べ)について〜
第3研修部 金沢義夫
「答」は実に体裁よく書くが,ときおり行う筆算はコチョ・コチョと乱筆で紙のわきでもとめ,提出するときになると筆算のところはあえなく消されてしまう。
ノートのときも同じで「答」を得れば,まるで「答」には無縁なもののように筆算はゴミと化してしまう。乱筆ながら筆算を軽くあつかって困ることがある。
たまたま設計しているとき,もう一度たしかめたい筆算があっても,どこにちらかしておいたのかわからなくたって,もう一度筆算の労をおわされたりする場合がよくある。
先輩はよく言っていた。
「設計の流れをきれいに記述する心得で世話になった筆算もていねいに書くべきである。出来得れぱノートの左頁を記述にあて,右頁を筆算にささげるぐらいの記録尊重の心得がほしい……」と
ドキュメントは作業の過程を述べたものとか,各段階の完成時の記録とでもいえよう。
このドキュメントの目的は
1 担当者にしかわからないといった障害を最少限にくいとめるために必要なこと。
2 内容の検討が開発と併行するたらば,その時点でドキュメントを通じて行うことにより,担当者の経験・技能の差が調整され,一定のレベルに,すべての態勢を保っておくことができる。
(すぐれた要員をかかえていても,満足できる人員であるといえない場合が発生する。)
3 完全なドキュメントがあれぱ,変更とか,つぎの作業の参照資料として容易にその機能を発揮するのは当然である。
(ドキュメントがないために,変更のむずかしさ,作りなおしの面倒とかはしばしば経験するところである。)
4 また,ひとつの目的として,いままでに作成されたテクニックを,他に対する教材として利用できる。
(着想は消滅して,永久の教材として現れないこともある。)教育用テキストは,こうした生きたものを取り入れることによって,より効果的なものとなる。
このドキュメントは業務分野に応じてさまざまな様式があろう。しかし,記録として残ることにより必要に即答してくれる共用的資料としての役割にかわりはない。
そしてこの文書を作成することは,製造業のような量産とは比較にならない。むしろ一品料理にあてはまるものである。
もしも設計に変更があれば,製造過程の関連部門に対する再手配は大変なものだが,設計部門には電話で簡単に連絡できるというソフトな一面がある。しかしながら設計部門では「設計とはなにか」というやっかいな問題をかかえている。
しかしながら設計部門では「設計とはなにか」というやっかいな問題をかかえている。
機能をいかに正確に,しかも能率よく生かすかということと,それをいかに明確に記述し保存するかということである。
たとえばプログラム・ドキュメントの仕様を
1. プログラミングの概要
2. プログラムの流れ図
3. モジュールの機能
4. 使用言語
5. 入出力設計
6. データ・リスト
7. 補足(参考文献)
のように様式化しておくことは,情報処理への重要な過程である。コンピュータは単なる計算機ではなく,情報を処理するものとして利用されている。散逸している資料の集合態から,意味のある必要な配りのものだけを集め,そこに新しい組立てを得ようとしている。
開発のための資料が目々増加している今日にあっては,これほど便利な助手はいたい。
ドキュメンテーション(情報探索)にはドキュメントの正確,明瞭,または標準化,コード化などがどうしても必要なのである。
すなわち,日常の正確・簡明なドキュメントは,ドキュメンテーションによって生彩をはなつであろう。
「明日は雪だ」という情報によって外出をやめる者もあれぱ,スキーに出かける者もある。
この概念のコード化などと……ドキュメントの問題は外にも多々あるが,情報処理にひとつの仕様を工夫してみることは,つぎの開発を助長することになろう。