メインコンテンツへスキップ
見出し画像

基本設計書を書く前に

    基本設計で手が止まる場面は珍しくありません。

    その背景には、

    「何を書くか」よりも「どの段階の整理をしているのかが曖昧」

    という状況があることが多いように感じます。

    設計を進める際には、いきなり成果物を書こうとするのではなく、段階ごとに整理対象を分けて考えると進めやすくなる場合があります。


    まずは全体のロードマップ

    設計を進める際の一つの考え方として、以下のような流れがあります。

    データ
     ↓
    
    関係
     ↓
    
    動き
     ↓
    
    画面
     ↓
    
    仕様
    

    この順序はあくまで一例ですが、どこから整理を始めるか迷ったときの目安になります。


    一般的な開発工程

    要件定義
     ↓
    基本設計
     ↓
    詳細設計
     ↓
    実装
     ↓
    テスト
    

    この流れ自体は広く知られていますが、実務では「基本設計に入る前の整理」が十分でないと、途中で手が止まることがあります。


    基本設計が進みにくい状態

    例えば、次のような状況です。

    • 必要そうなデータはある程度分かっている

    • ドメイン知識もある程度ある

    一方で、

    • データ同士の関係が整理されていない

    • どのデータを起点に取得するかが曖昧

    • システムとしての流れがまだ見えていない

    このような場合、仕様が不足しているというよりも、

    情報の整理が途中の状態

    と捉えることもできます。


    設計の進め方の一例

    処理から考え始めるのではなく、段階的に整理していく方法もあります。

    データ
     ↓
    
    関係
     ↓
    
    動き
     ↓
    
    画面
     ↓
    
    仕様
    

    この順序で進めると、後続の設計が考えやすくなるケースがあります。


    手順イメージ

    ① データの洗い出し

    まずは、扱う可能性のあるデータを広く列挙します。

    入力データ
    
    中間データ
    
    設定情報
    
    外部ファイル
    
    出力データ
    

    ここでは粒度や分類にこだわりすぎず、「存在していそうなもの」を出していくことが目的です。


    ② データの関係整理

    次に、データ同士の関係を整理します。

    入力データ
     ↓
    中間データ
    
    設定情報
     ↓
    処理結果
    
    外部ファイル
     ↓
    参照データ
    

    この段階では、処理の詳細には踏み込まず、

    • どのデータがどのデータに依存しているか

    • どこから取得されるのか

    といった関係性に注目します。


    ③ 処理の整理

    データの関係が見えてきたら、それをもとに処理の流れを考えます。

    入力データ取得
    ↓
    必要な情報の抽出
    ↓
    設定情報の参照
    ↓
    データの加工
    ↓
    結果の生成
    

    ここで初めて「処理の順序」が具体化されていきます。


    ④ 画面・入出力の整理

    次に、ユーザーとの接点や入出力を整理します。

    • 入力として何を受け取るか

    • 出力として何を返すか

    • 画面や操作の流れはどうなるか

    この段階で、システムの外側との関係が明確になります。


    ⑤ 仕様化

    ここまで整理した内容をまとめることで、基本設計書として形にしていきます。


    開発工程との対応イメージ

    上記の流れは、開発工程に当てはめると次のように整理できます。

    要求整理
     ↓
    
    情報整理
     ↓
    
    機能設計
     ↓
    
    実装設計
     ↓
    
    実装
    

    各フェーズの成果物例

    ① 要求整理

    目的:何を作るかを整理する

    • 要求一覧

    • As-Is業務フロー

    • To-Be業務フロー


    ② 情報整理

    目的:必要な情報を整理する

    • データマップ

    • データ辞書

    • データ取得ルール

    • データ依存図

    ※この段階では処理を無理に書かないこともあります


    ③ 機能設計

    目的:システムの動きを整理する

    • 処理フロー

    • 画面遷移図

    • ワイヤーフレーム

    • 入出力一覧


    ④ 実装設計

    目的:実装に落とし込める粒度にする

    • クラス図

    • シーケンス図

    • API仕様

    • 関数仕様


    ⑤ 実装

    • ソースコード

    • テスト

    • レビュー


    UMLを書くタイミング

    UMLは便利なツールですが、使うタイミングによっては扱いづらく感じることもあります。

    例えば、以下のような整理がある程度できていると活用しやすくなります。

    • データの所在

    • データ同士の関係

    • 入出力の整理

    UMLが比較的向いている対象:

    • 処理の流れ

    • クラス構造

    • オブジェクト間の関係

    一方で、

    • データがどこにあるかを探る段階

    • データ取得の経路を模索している段階

    では、別の表現(データマップや一覧など)の方が扱いやすい場合もあります。


    まとめ

    基本設計に取り組む際には、いきなり仕様を書こうとするのではなく、

    1. データを洗い出す

    2. データの関係を整理する

    3. 処理の流れを考える

    4. 入出力や画面を整理する

    5. 仕様としてまとめる

    といった段階を意識すると、進めやすくなることがあります。

    ただし、プロジェクトや状況によって最適な進め方は異なるため、あくまで一つの参考として捉えていただければと思います。

     
     

    Fuji

     
     
    備忘録としてchatGPTに聞いたことをただ貼り付けている記事もあります(タイトルに「メモ○○」)。内容の正誤判定を実施する”前に”投稿しています。記事内容を参考にされる場合は自己の責任において判断をお願いします。いくつかは自分で書いたものです。

    あなたへのおすすめ