ドキュメントの書き方について

質問

CGIアプリケーションでWEBシステムを構築しています。
概要は「予約システム」になります。

このシステムのドキュメントを作成するに当たり
どのように書いたらいいのか、悩んでいます。

皆さんはどのようなドキュメントを作成しているのでしょうか？
サンプルや参考サイトなどがあれば教えていただけないでしょうか？

よろしくお願いいたします。

回答No.2

YkazubonY · ベストアンサー

内部仕様書と外部仕様書が有ると思います。
内部仕様書は、
RDBを使っているのなら、各テーブル間の関係は、ER図が良いと思います。
CGIのモジュール一覧表を作ると後で、直す箇所が分かります。
関数一覧表も後々便利です。
モジュール遷移図を作り、画面パラメータを書いて置くと、便利です。
各CGI毎の細かい処理は、PAD図で記述するのが良いと思いますが、
時間がもったいないので、止めましょう。
それより、ソースに処理内容をコメントととして、たくさん書いたほうが実用的です。
外部仕様書は、
運用部署に入出力データと処理の関連を理解してもらうためには、業務フロー図が良いと思います。
http://itpro.nikkeibp.co.jp/article/COLUMN/20080619/308731/
操作説明書は、各画面毎に作れば良いと思います。
A3用紙に各画面を矢印で並べて繋げて、画面遷移図を作ると良いです。

お礼

YkazubonYさん、
詳細に書いてくださり、助かりました。

上記の中から必要そうな資料を作成していきたいと思います。

有難うございました。

回答No.1

Taiyonoshizuku

ドキュメントって、設計書？説明書？

補足

Taiyonoshizuku さん、

設計書、「プログラム設計書」になります。
よろしくお願いします。