読者です 読者をやめる 読者になる 読者になる

hotoolong's blog

Railsやvimや気になったことを綴ってます

設計書の有無よりも設計意図が大切

プロジェクト運営

ここ最近Railsのソースをかなりよみよみしてます。
徐々にRubyに馴染んできてますが、、まだまだ初心者という感じですね。。
新しい職場では比較的ドキュメントがなく
コードを読んでナンボという感じです。
徐々にソースも読めて、何をやってるか大体わかるんですが、、
それだけでは何をやりたいかってやっぱりわからないところもあります。


そう、それは意図が見えないと、かなり分らないものです。
何のためにそれをするのか、その意図が重要になります。


以前働いていたところでも設計するときの記載方法に意図を込めたり、
人の設計書をチェックするときも意図が分る記載方法を指摘していたりもしてました。
設計書では言い表せないところを如何にフォローできるかというところも結構肝心だと感じます。
ある程度行間を読んで、意図を汲み取ってたりするのですが、
やっぱりそれだけでは難しいなと感じます。


設計書も書く内容を決めて、ユースケース図とか、シーケンス図とか作ったりもしますが、
肝心なのは意図なんでしょうね。
後はそれを実現するのにどうやって動くかが分ればいいんでしょうけど、、
実際にそれが出来てるところって少ないのかなと思いました。