概要

詳細設計で作成していくものや、その内容などを書いていきます。

詳細設計とは

詳細設計とは、基本設計で決めたシステムの大枠から、機能ごとに、どんな実装をしていくのかを決めていく作業になります。

作成物一覧表

こちらが詳細設計で作成するものです。場合によって作成するものが変わることが多いと思いますが、現在の私の就業先で作成しているものを記していきます。

作成するもの	説明
表紙	何の設計書なのかをすぐわかるようにするためのもの
クラス図	システムの静的な構造・関係性を視覚的に表現するための図
シーケンス図	オブジェクト間の処理の流れを時系列で表していく図
外部IF一覧	各機能で使用するパラメータをまとめたドキュメント
外部IF詳細	各機能で使用するパラメータの詳細をまとめたドキュメント
画面詳細	画面上の具体的な表示や、何の操作が行えるかの詳細を記述するドキュメント
改版履歴	顧客に見せた後、内容の修正があった場合にそのタイミングで記入するものです。

1つずつ説明していきます。

表紙

表紙はこんな感じで作るのが一般的です。

クラス図

クラス図はUML（統一モデリング言語）のひとつで、特徴は「システムの静的な構造・関係性を視覚的に表現するための図」であることです。視覚的に表現するというのがポイントです。
詳しくは、こちらの記事をご覧ください。
https://qiita.com/hukuryo/items/4d8c3d1f3d3e0cab6589

シーケンス図

シーケンス図とは「プログラムの処理の流れや概要」を設計する際に使われます。オブジェクト指向のソフトウェア設計においては、グローバルスタンダードの設計手法で、オブジェクト間の処理の流れを時系列で表していく図になります。
こちらも、記事を書いているので、詳しい説明はこちらをご覧ください。
https://qiita.com/hukuryo/items/431e58fe7d077db882c5

外部IF一覧

こちらは、各機能で使用するパラメータをまとめたドキュメントを一覧でまとめた表になります。

外部IF詳細

各機能で使用するパラメータの詳細をまとめたドキュメントになります。
こちらは、設計段階で書きますが、実装の中でパラメータに変更があった場合は、それに伴い詳細の内容を変更する場合もあります。

画面詳細設計書

画面上の具体的な表示や、何の操作が行えるかの詳細を記述するドキュメントになります。

画面詳細一覧表

画面上の具体的な表示や、何の操作が行えるかの詳細を記述するドキュメントの一覧になります。

改版履歴

顧客に見せた後、内容の修正があった場合に誰が、何の書類を変更したかをわかるように記録するために用意するものです。

まとめ

詳細設計では、基本設計を掘り下げた設計をしていきます。アプリケーションにもよりますが、実装してみないとパラメータなパラメータなどは、初め書いた設計書に変更を加えながら書いていくこともあるそうです。
以上になります。
[cv:issue_marketplace_engineer]