設計書の項目

様々な設計書を囲みてきたがかなりバラバラな感じがする
昔からのSierさんはオンプレ時代の設計書を踏襲していることもあるんだが
クラウドになってリンクをはっておしまいという物もかなり散見される。
たしかにどんどん変わってしまうので最初は基本的なところをつくったら環境を直接見てねの方がよいが・・

やっぱあった方がいい　初期の設計として作った方が良いよね・・・
自分用に検索できるようにメモ

■機能要件の例

業務フロー

  • 業務プロセス概要
  • 業務シナリオ
  • 画面遷移図（UI/UX設計）

ユーザ管理・認証認可

  • ユーザー登録、権限設定
  • ログイン、ログアウト、SSO対応
  • 権限レベルごとのアクセス制御

データ管理

  • データ登録・更新・削除・検索機能
  • データ連携（外部システムとの連携）
  • データ整合性維持の仕組み

帳票・レポート

  • 各種帳票の定義、出力フォーマット（PDF、Excel等）
  • レポート生成と配布機能

通知・アラート機能

異常検知・自動監視によるアラート発報

メール通知・プッシュ通知

■非機能要件

① 性能・パフォーマンス

  • レスポンスタイム（平均、最大）
  • 同時接続ユーザー数・同時処理数
  • 負荷テスト・ベンチマーク基準

② 冗長性・可用性（可用性設計）

  • SLA（サービス稼働率：例99.99%など）
  • 障害時のフェールオーバー、冗長化構成（アクティブ-アクティブ／アクティブ-スタンバイ）
  • 障害検知・自動復旧方法

③ セキュリティ

  • 認証認可のセキュリティ強化（MFA、ゼロトラスト等）
  • 暗号化（通信経路・保存データの暗号化方法）
  • ログ管理・監査証跡
  • 脆弱性対策・パッチ適用方法
  • セキュリティインシデント対応フロー

④ 拡張性

  • 将来想定するスケールアウト・スケールアップの方針
  • モジュール単位での独立性、API設計による機能拡張容易性

⑤ 保守性・運用性

  • ログ監視方法、障害監視ツール・運用監視体制
  • システムメンテナンス（更新・バックアップ・リストア手順）
  • リリース・デプロイ方法（CI/CDなどDevOps関連）

⑥ 移行性

  • システム移行計画（新旧システムの並行運用、移行手順）
  • データ移行の方式、データ整合性チェック方法

⑦ バックアップ・災害復旧（DR設計）

災害復旧（DRサイト、RPO/RTOの設定、BCPの整備）

バックアップ方式（定期バックアップ・差分バックアップ）

【３】インフラ・技術要件

具体的なインフラの内容を定義します。

  • クラウド基盤の選定（Azure、AWS、GCPなど）
  • 使用するPaaS/SaaSサービスの明記
  • ネットワーク設計（VNet、サブネット、FW設定）
  • サーバー構成図（アーキテクチャ設計）

  • システム制約条件
    • 法律・業界規制など遵守すべきルール
    • ライセンス関連（ソフトウェア、ライブラリなど）
  • リスク管理計画
    • プロジェクトのリスク特定・対応計画
  • システム連携要件
    • 連携システムとのインターフェース仕様（REST API仕様、通信プロトコルなど）

📖 参考URL（設計書作成ガイドラインの例）

コメント

タイトルとURLをコピーしました