「設計書のページ数が多く、どこから読めばよいか分からない」
「読んだはずなのに、処理の流れを説明できない」
システム設計書は、要件、画面、データ、処理、外部連携、運用など、複数の資料に分かれています。最初から一行ずつ読むと、詳細に埋もれて全体像を見失いがちです。
設計書を読む目的は、内容を暗記することではありません。対象機能が何のためにあり、どの入力を受け、どのように処理し、何を出力するかを説明できる状態にすることです。
開発・保守では、設計書だけで全情報が完結しないこともあります。関連資料、既存動作、ソースコードとの不一致を見つけたときは、どれが正しいかを自己判断せず、確認事項として整理します。
この記事では、若手SEが設計書の全体像を短時間でつかみ、詳細を読み解く順番を解説します。
設計書は「目的→流れ→詳細→例外」の順に読む
最初に業務目的と対象範囲を確認し、次に処理フローで入口から出口までをつかみます。その後、画面項目、データ、外部連携、エラー処理の詳細へ進みます。
この順番なら、各表や項目が処理全体のどこに位置するかを理解しやすくなります。
| 段階 | 確認内容 | 自分への問い |
|---|---|---|
| 目的 | 業務目的・利用者・対象範囲 | 誰の何を解決する機能か |
| 流れ | 入力から出力までの正常系 | 処理を3分で説明できるか |
| 詳細 | 項目・分岐・データ・連携 | どの条件で結果が変わるか |
| 例外 | エラー・取消・再処理・運用 | 失敗時にどう戻るか |
| 関係 | 上位・下位・関連資料 | 同じ定義がどこにあるか |
設計書を読み解く4ステップ
1．目次・改訂履歴・対象範囲を確認する
目次から資料の構造を把握し、改訂履歴で直近の変更理由を確認します。対象機能、対象外、前提条件、関連資料も先に押さえます。
古い版や別案件の資料を読まないよう、版数、更新日、承認状態を確認します。
- 文書名・版数・承認状態
- 対象機能・対象外
- 直近の改訂理由
- 上位要件・関連設計書
- 用語・略語の定義
2．正常系の処理フローを一本で追う
代表的な利用者操作を一つ決め、画面入力、業務チェック、DB更新、外部連携、画面出力まで追います。途中で別資料へ移る場合は、参照先をメモします。
まず正常系に絞ることで、機能の骨格を理解できます。詳細な例外は後から重ねます。
3．入力・分岐・データ・出力を対応付ける
画面項目やAPI項目が、どのチェックと分岐に使われ、どのテーブルへ保存され、何として出力されるかを対応付けます。
項目名が資料ごとに異なる場合は、業務名、物理名、API名の対応表を作ると理解しやすくなります。
入力：振込金額 チェック：1円以上・上限額以内 分岐：上限超過なら業務エラー DB：取引テーブル.amount 外部連携：送信電文.transferAmount 出力：受付完了画面に表示
4．異常系・取消・再処理・運用を確認する
正常系を理解した後、入力エラー、タイムアウト、DBエラー、外部連携失敗、取消、再実行などを確認します。エラー時にデータがどこまで更新されるかが重要です。
設計書に書かれていない運用判断や手作業がある場合は、運用手順書や担当者への確認も必要です。
設計書読解メモのテンプレート
読んだページを要約するより、処理を説明できる形でメモします。
【業務目的】 利用者： 目的： 対象範囲： 【正常系の流れ】 1. 入力： 2. チェック・分岐： 3. DB・外部連携： 4. 出力： 【異常系】 主なエラー： データ状態： 再処理・取消： 【関連資料】 上位資料： 下位資料： 【質問】 事実： 自分の解釈： 確認したいこと：
質問するときは「分かりません」だけでなく、確認した資料、自分の理解、矛盾している箇所を添えると、相手も回答しやすくなります。
よくある失敗と改善方法
| 失敗 | 起こる問題 | 改善方法 |
|---|---|---|
| 先頭から細部まで読む | 全体像を失い、時間がかかる | 目的と処理フローを先に確認する |
| 一つの資料だけで判断する | 前提や関連定義を見落とす | 上位・下位・関連資料をたどる |
| 不一致を実装に合わせる | 実装側の誤りを正としてしまう | 要件・設計・実装の正を確認する |
若手SE向けチェックリスト
- 版数・承認状態・対象範囲を確認した
- 業務目的を一文で説明できる
- 正常系を入口から出口まで追った
- 入力・分岐・データ・出力を対応付けた
- 異常系・取消・再処理を確認した
- 関連資料と用語定義を確認した
- 不一致を事実・解釈・質問に分けた
まとめ：設計書は処理を説明するために読む
設計書の読み方で大切なのは、ページ数をこなすことではありません。業務目的と処理の流れをつかみ、必要な詳細を関連付けることです。
最初は分からない用語が多くても、入力から出力まで一本の処理を追う経験を重ねると、別機能の設計書も読みやすくなります。
- 目的と対象範囲から読み始める
- 正常系の処理フローで骨格をつかむ
- 詳細と異常系を処理の流れへ重ねる
コメント