個人開発での設計書の要否

Question

###質問したいこと
個人開発でアプリケーションを開発する場合でも
軽くUMLやデータベース設計などを書き出しておいた方が良い点、または必要のない理由などありましたら教えていただきたいです。
もちろん規模や種類にもよるかと思いますがどのようなアプリであれば良いか、
どの規模ならどこまで詳細に設計しておいた方が良いのかなどあれば教えていただきたいです。

###メリット？

• おおまかに全体図くらいは書き出しておいた方が取返しのつかない設計ミスが減りそう
• あらかじめ形にすることでモチベーションが上がりそう。
• なんとせっけいしょがかけるようになる。

###デメリット？

• 時間がかかる
• 書き終えた時点でモチベーションを使い果たしそう
• 色気づく

実際に個人開発で設計書を書いた経験などあれば教えていただけると助かります。

Answer 1

ちゃんとしたものでなくとも、メモ書き程度は残しておいたほうが後で見返したり整理するときに便利だとは思います。

１週間ぐらいで作れてしまうようなものなら特にいらない気がしますが、時間がかかるとか、間が空いてしまうという場合には簡単でも書いておいたほうが良いのではないでしょうか？

Comments

[damalnylpo]

回答ありがとうございます！
クラス図やER図までいかなくとも
概要とちょっとした覚え書きだけメモしておくくらいが良さそうですね。
ありがとうございました！

Answer 2

UMLならばユースケース図とアクティビティ図、DBならばER図くらいははじめの段階で書いても良いと思います。備忘録とか、考えをまとめるためとして。

言語次第ですがクラス図は、ツールでコードと同期がとれるならば、書いても良いと思います。といってもせいぜいpublicメソッドくらいで十分だと思います。

Answer 3

ドキュメントの作成は手間ですが、
メモ程度にでも確実な記録として残す方が良い気はします。

人の記憶は曖昧なものなので、
時間が経てば経つほど記憶は当てにならず、プログラムと長時間睨めっこという事態になりかねません。

何かメモ程度でも記録に残すことによって、
不確かだった記憶が鮮明になることもあるよというのが個人的な意見です。
(ただし後から見返して分からないレベルはNGですが^^;)

数日レベルでできるプログラムで、
すぐに全体が把握できるような規模であるなら、記録に残さなくても良いかもですが。(そこは時間との要相談ですね)

Answer 4

他の方と同じですがメモ書きで十分と思います。
ER図は要らないんじゃないかな。自分が設計したDBなら、時間がたってからでもテーブル定義を見ればすぐにER図を再現できそう。テーブル数はそれほど多くありませんよね？
UMLも不要と思います。ロジックの説明はソース中にコメントで書けばよいかと。私はコメントは多めに書くのを心かげています。

逆に書いておいた方がいいと思うのは、仕様です。これも箇条書き程度でいいんですけど。
後になって「こういう場合はどう動作するんだっけ？」とか、
使っていてバグっぽい挙動を見つけたので直したいけど、本来はどうしたかったんだろう
という疑問を抱くことがあるからです。自分が作った機能なのに忘れていたなんてこともあります。