ツールを作成する為の設計書を作成する

自分でツールを作成するにも外注に依頼するにも、先に簡単な設計書を作成しておくと便利です。粒度はあまり細かくなくても良いとは思いますが、自分のやりたい事を簡潔にまとめておくことで後から見返すときのマニュアルにもなります。

私が設計書を作成する場合は概要⇒詳細⇒補足といった流れで作成することが多いです。
以下、実際に外注のプログラマに依頼する際に作成している流れでご紹介します。
多々マスキングしていますが、何が正解ということも無いので、こんな風に依頼しているんだという感触を掴んで頂ければと思います。

概要

作成しようとしているツールが「何をするのか」「どのタイミングで起動されるのか」を明確に大まかに記載しておきます。

詳細

ツールの詳細をステップ単位で出来るだけ細かく嚙み砕いて記載します。
処理の分岐が発生する箇所は全て入れ子で記載していきます。こうすることでプログラマの方が迷うことを極力減らすことが出来ます。

補足

前項の補足で画面のハードコピーや絵を入れて補足します。

以上、ご参考までに。

出来ればポチお願いします^^