こんにちは。米山です。
いくつか前のブログで、プロジェクトでAPIを使っていると書きましたが、
そのプロジェクトで詳細設計工程から参加させていただきました。
そこで、今回は詳細設計工程を通して学んだことを共有したいと思います。
詳細設計工程の成果物として、詳細設計書があります。
詳細設計書とは､仕様内容や動作の実現方法が具体的に記載された設計書の事です｡
詳細設計書を元に開発をしていくので､誰が読んでも同じものができるように記述しなければいけません。
感じたこと
- 複数の視点を持つこと
今回私が作成した詳細設計書では、開発者視点それも、どう作るかのみしか考慮できていませんでした。
レビューを通じて、保守性や拡張性を考えた設計をすること、お客様がどのように使うか、どう使えば使いやすいシステムになるかを考える必要があることを学びました。
これらの視点を持つことで、より使いやすく、長期的に運用しやすいシステムを設計できることを実感しました。
難しい点
今回のプロジェクトでは、APIの仕様が明確にわかっていない段階から詳細設計に入ったので、仕様をすべて出し尽くすのが難しかったです。
また、詳細設計の段階では、考慮できていない仕様などがプログラムを書いているときに見つかり設計書を修正することがありました。今回は、自分で設計書を書いて、自分でプログラムを書いているのであまり大きな問題にはなりませんでした。しかし、設計書を書く人とプログラムを書く人が異なると、仕様の変更が伝わっておらず、意図しないプログラムが完成してしまう可能性があります。
将来的には、だれが見ても同じものができ、仕様の抜け漏れがない詳細設計書を作成できるように頑張ります。
