久しぶりにJavaしている今日この頃です(3)
今週はドキュメントWeekデス(・ω・)。
開発標準、ファイル構成、コーディング規約とかは良いとして、メインとなるのはアーキテクチャ設計書。
アーキテクチャ設計書に書くのは、各機能(サブシステム)担当が使うための、アーキテクチャ(レイヤ)構成、各レイヤの処理の実装方法(実装要件)、共通機能の使い方とかに関して。
Insideな話ではなくて、とりあえずこれだけ読んでおけば設計思想と作り方がわかる…的なものができると良いのだけれど(´ー`)
アウトラインについてはこんな感じを構想中。
- 概要
- 全体構成(レイヤ構成、名前空間)
- 使用ライブラリ
- コントローラー/アクション(無設定化について画面操作関連(URL直打ち、F5、戻る))
- ロジック(トランザクション)
- データアクセス層/DAO
- DTO
- ビュー層/JSP(タグライブラリ)
- AJAX
- 携帯
- ポートレット的なお話
- 外部連携
- 認証
- ログ
- 共通ユーティリティー
- 例外設計
- テスト(UnitTest)
- デバッグ(デバッグ用Filter、Intercepter)
- 設定ファイル
他にもなにか注意しておかないといけない事ってあるかしら(・ω・)?
最近はアーキテクチャについて共通認識のある知っている人達との仕事が多かったわけですが。
今回は色々な人達が関わるし、ちゃんとしたドキュメントも用意しないとね〜という事で。
メインの人達とちょっと話をした限りでは、考え方とかについての共通認識は持てたっぽいけど、さて。