基本設計書のアウトライン（案）

今度こそ基本設計書のアウトラインを作成してみた。今後また作成することもあるだろうからメモとして残しておく。

基本設計書として以下の4ドキュメントを作成。

• 環境設計書：使用するサーバと構成について
• アプリケーション設計書：アプリケーション全体の設計、個々に切り出される機能について
• 開発手順書：開発手順、コーディングルールなど
• 運用設計書：運用全体の考え方、納品したお客さまが参照する操作マニュアル類

環境設計書

• 構成図：サーバの構成についての説明と図示（APサーバ、データベース、イメージ専用サーバ、（メールサーバ））
• 使用ソフトウェア：OS、APサーバ、データベースの名称、バージョン、URLなど

アプリケーション設計書

• プロダクト構成：使用するフレームワークやライブラリについて
  • 構成図：MVC2モデル図
  • プロダクト：DI、ORM、ajax、テストなどで使用するプロダクトの名称、バージョン、URLなど
• クラス設計：クラス構成、継承などのルール、シーケンス図
  • PC版
  • 携帯版
  • Flash：Flashに関連する部分の設計
    • Flashとのインタフェース定義
• 画面設計：
  • 画面設計書：
    • 項目定義（画面単位に作成）
    • バリデーション定義：一枚にシートに汎用的に
• データベース設計：クラス図を元に
  • テーブル設計
  • コード定義：（≒マスタ定義）
• セキュリティ設計
  • SSL：SSLにする部分
  • 不正アクセス
    • SQLインジェクション、サニタイズなどの対策方針
• コンテンツの設定
• 決済

開発手順書

• 開発手順／コーディングルール
• テスト：テストを書く単位、実装方法

運用設計書

• 運用設計：アプリケーション全体の運用について
  • 管理系パスワードの考え方：FAXで送る（メールでは送らない）
  • 監視項目
    • 死活確認：各種サーバの死活確認について
• 操作マニュアル：事務局、会場が操作するマニュアル
  • 管理者：システム起動手順／システム停止手順、アカウント作成方法など
  • 障害対応マニュアル：
    • 障害復旧手順：障害発生時の対応と復旧手順について