【詳細設計】詳細設計が難しい。【大体そんなもん】
始めましての方、初めまして。
それ以外の方、私だ こんにちは。
この記事を読んでできること。
詳細設計というものが何となく理解できる
社会人として3年目。今日、こんなことがありました。
会社にて
上司「新人たちに詳細設計書かせて」
と、言われ
私「あ～はいはい。おkおk。」
と、私は答えました。答えてしまいました。
(実際はちゃんと「かしこまりました。」って言ったわけですが...)
んで、ふと思ったわけです。
........詳細設計の書き方ってどう教えたらいいんだ？？？
と。
なぜ、書き方を説明できないんだ？と自分でも不思議に思っていたのですが、私自身、初めて詳細設計を描いたのは常駐していた派遣先でした。
その時、社会人1年目だったので素直に「書き方教えてください」と言えればよかったのですが、その時の私の教育係(私より先に常駐されていた自社の女先輩)の人がですね......私が気にくわなかったのか「調べれば？」の一言で突っぱねてきやがりましてね？
「今、あなたに聞いてるやん(調べてるやん)。」と心の中で毒づいていたわけですが....
結局、常駐先のプロパーの方に伺い、快く別の仕事の詳細設計を見せていただけたので解決しました。
が、その結果、書き方なんて千差万別だってことがよく分かりました。内容が丁寧な方もいるし、ものすごく大雑把に書いている方もいました。
そして今現在、これからの未来を担う新人たちに誤った知識を植え付けて腐らせる訳にはいかない。フレッシュなままでいてほしい。
と思い、改めてGoogle神に教えを乞ったわけです。
┓流れ┓
⚠︎attention⚠︎
文中の中でも書いてあると思いますが、IT業界に足を踏み入れてたかが3年程度のペーペーが書きます。
設計書というものは必ずこれだよ。と決まっているものではないと思っています。
閲覧された方のなかでも「ん？」と思うところもあるかと思いますが、そこは𠮟咤激励のお言葉ぜひお願いします。
では、話が脱線しないように頑張ります。
では、行ってみよー！
内部設計書。とも言います。
詳細設計では何を書くのか。
基本設計で決められた動きを、どうやって実現するかを記述する
文字が読めるので日本語だと思いますが、私が理解できない。
はい、じゃ。次....
基本設計をもとにして、実際にプログラムが作れるように詳細を描く
さっきよりは何となく理解できた。
しかし、詳細に書くとはいっても、難しい。
何が難しいのか。詳細にする加減(レベル)が分からないのです。
参考にさせていただいたページなのですが....
参考リンク：https://sirokuro-2.hatenadiary.org/entry/20100106/1262784265
このページに書かれている、詳しすぎる詳細設計書。
このサイトのページを読んで、ビンタを食らった気持でした。
なぜなら、私も詳しすぎる詳細設計書を今でも書いているからです。
詳細設計書を書く際、「他人が見ても書けるくらい詳細に書いて」と言われ、心がけてきました。
1年目で常駐していた時の先輩には「あんたでも理解できるようにやさしく書いてあげているんだからね？」と必ず念押しされて、先輩が書いてくださった詳細設計書を見せてもらっていました。一言多いんだよね。と思いながらもそれが正しいと思っていたわけです。
そんな詳しすぎる詳細設計書を正しいと思い込んでいたからこそ、プログラム設計書と何が違うのかも理解で来ていなかったということですね。
詳しすぎる詳細設計書については、私も今後書き方に注意したいと思います。
けれど、まだまだ3年目なのですがその3年の中で、7件ほど派遣させていただきました。
派遣先にて拝見させていただいた詳細設計書ですが、ちょいちょい会社によって書き方が違うのもまた事実です。
むしろ、部署で統一性を持たせるためにフォーマットを用意していた会社様もありましたし、フォーマットなんてないからWebからダウンロードしてきたテンプレを運用していたり、Excelで1から作成していたりと様々です。
なので、その常駐先に合わせた書き方をしなければならないところが難しいところです。
(だって、違う書き方したらレビューしたとき、ボロクソ言われたし.....)
先駆者の方々のご意見も閲覧させていただきました。
参考リンク：https://anond.hatelabo.jp/20161105155342
この記事を読んでいて、文面の最後の「甘えんな」に笑ってしまいました。
確かに今まではバグがあるごとに、ソースを日本語化した詳細設計書(という名の詳しすぎる設計書)を書いていたので、管理がめんどくさい。と不満がありました。
で、以下の記事も閲覧させていただきました。
参考リンク：https://blog.goo.ne.jp/hishidama/e/3118f6e7161f486700c5f05e21b5ce4f
むむむ。どちらの記事も「確かに」と読んでいました。
そうなると、必要/不必要の問題ではなく、やはり『書き方』の問題なのでしょうか？？
そして最後、
参考リンク：https://www.deep-rain.com/other/1058
綺麗にまとめてくださいました。
頭の中のモヤモヤがうっすら晴れた気がします。
自分の中で「必要/不必要」と考える前に、詳細設計書が何に使われるのか聞け。
ということですね。
と、改めてふと昔のことが思い浮かんだ。
「あんたでも理解できるようにやさしく書いてあげているんだからね？」と必ず念押してきてくれやがった先輩に対してムカムカしてきたので、いつかあったら心の中で「ちゃうやんけ」と言ってやろ。まぁ、相手は覚えてないだろうけど。なんてったってオバサンだし.....
