初日 最新 目次 MAIL HOME


*-- To Tell The Truth --*
Cruz
MAIL
HOME

My追加

2001年08月29日(水)
サボリのち出勤

昨日1日休んで、今日は気持ちも新たに出勤。
・・・で、仕事はというと別に何かあるってわけじゃないんだな。
正確には、これをやれって指示を受けていない。
自主的に今まで作ったプログラムのドキュメント作成をしている。
そう・・・私がいつ居なくなっても迷惑をかけないように

会社的にドキュメント用書類フォーマットがあったりとか、仕様が決まっていたりそう言ったものがないのか?
私が外様(=派遣)だから教えてもらえないのか?
何も手がかりが無いので、自主的に勝手気ままなドキュメント作成を行っている。

今回の仕事はVC++での開発だった。
VC++のドキュメント作成って・・・したことないんだよね。
CだろうがC++だろうが、たいした違いは無いんだけど、画面(ダイアログとか)がくっついてくるからなぁ。
・・・ということで、以下のような形でワープロ作業に励む事にした。

1章 システム概要
2章 画面遷移(画面のハードコピーを遷移順に貼り付けただけ)
3章 仕様
 3−1章 (画面単位の機能)
  3−1−1章 目的
  3−1−2章 機能(特徴のある機能を箇条書き)
  3−1−3章 画面フォーマット(ダイアログとかで入出力関係のID等一覧表)
  3−1−4章 モジュール一覧(使用関数一覧表)
  3−1−5章 ファイルフォーマット(機能がファイル入出力を行い場合、使用したファイルフォーマットを記述)
 3−2章・・・続く

こんな感じで事足りるだろうか?
画面単位の方が追いやすいかと思ったが、そうでもないかなぁ?
まぁ、慣れている人ならこんなものを見るより、ソース見たほうが早いんだろうけどね。
ソースもボロボロだったりして・・・