😺

初めての詳細設計を任されたエンジニアのための教科書

2023/01/23に公開約900字

導入

エンジニアであれば避けては通れない詳細設計ですが、初めは取っ付きにくいことも確かだと思います。今回は、業務で初めて詳細設計をする人向けに詳細設計の目的、構成など、これを読めば一通りできるぞ!というところまでをゴールにして、記事にしていきたいと思います。

詳細設計とは

詳細設計とは、基本設計からプログラムに落とすための設計図を作る段階です。
簡単な言葉で言うと、要件定義の際にまとめた「〜できる」の数々を、図や表などを用いて視覚的にわかりやすい状態の設計書を作る工程とも言えます。
つまり、詳細設計書というのは、これまでの経緯を知らないエンジニアが新規でjoinした際にでも、詳細設計書を見るだけでコードに落とせる状態にまでなっているのが、理想的な詳細設計なのです。
そのために、文章で定義されていて抽象的な状態の基本設計書を、図や表などを用いてより詳細に詰めていくのです。

詳細設計に必要な項目

詳細設計では、テーブル間の関係を明確にするER図や、クラスやオブジェクト間のやりとりを時間軸に沿って表現するシーケンス図などをよく用います。
文章量が膨大になってしまうので、具体的な作成方法は割愛し、それぞれの簡単な紹介に留めておきます。

ER図とは

「データベース設計(データモデリング)で使う設計手法」です。
英語では、「Entity Relationship Diagram」と表されます。

シーケンス図とは

クラスやオブジェクト間のやりとりを時間軸に沿って表現する図です。
英語で、sequenceは「一連の」という意味があります。

API設計書

HTTPメソッド、エンドポイント、リクエストパラメータ、レスポンスなどが明記されていると良いでしょう。

まとめ

簡単にですが、詳細設計に必要なことをまとめてみました。ここは本当に触りの部分なので、一つ一つ丁寧に深めて行ってください。

Discussion

ログインするとコメントできます