アプリケーションの仕様書の作り方

質問

アプリケーションの仕様書の作り方

趣味で携帯電話用のアプリを作っています。最近になり作った数も増え、少しは複雑な事も出来るようになりました。そうなってくると、後で自分が作った物を再利用したくても、何を考えて作ったのか全く思い出せません。何かしら文書の形で資料を残さねばとは思うのですが、仕様書のようなものを作ったことが無いので、どうすれば良いか皆目見当がつきません。

ぱっと思いつくところでは
・どんなアプリか:概要
・動作フロー
・変数一覧(デバイスリスト)
・関数一覧
・通信を伴う部分では、リクエストURLやパラメータ
などがあるかと思います。こんなフォーマットで作ると良い、こんな事を書くと良い、といったアドバイスを頂けたらありがたいです。よろしくお願いします。

回答No.2

mpro-gram

どのプログラム言語を使っているのか不明ですが、再利用というと、関数やクラスだと思うので、それらの定義文の前に、関数の呼び出し法、引数、返値、動作概要などをコメントするのがよいかと。
書式としては、以下のように、言語によって、ソースからコメントを取り出して、ドキュメントファイルを作ってくれるユーティリティもあります。

Java だと、javadoc という、ソースにクラスやメソッド、プロパティの説明を入れる書式があります。この書式に沿っていれば、標準APIドキュメントと同じ書式で、htmlドキュメントを作れます。
http://java.sun.com/javase/ja/6/docs/ja/tooldocs/javadoc/index.html

perl にも、POD形式でソース内にコメントを付けておくと、perlユーティリティプログラムで、htmlやLatex、または通常テキストなどに変換できます。
http://perldoc.jp/docs/perl/5.6.1/perlpod.pod

phpにもphpDocumentor というプログラムがあって、javadoc のような形式で、コメントを入れておくと、コメントを取り出して、ドキュメントファイルを作ってくれます。
http://php-web.net/

回答No.1

SAYKA

再利用するというのが前提なら「リファレンスマニュアル」とか「ライブラリドキュメント」みたいのにすると　良いんじゃないかな。

http://help.adobe.com/ja_JP/Director/11.0/help.html?content=Part02_Scripting_Dictionary_1.html
http://msdn.microsoft.com/ja-jp/library/52cs05fz.aspx
http://www.php.net/manual/ja/
参考に。↑のは規模が大きい物だけど、使う側も再利用側も、こういう感じであれば勝手は悪くないと思うけど。。。