システム開発で必要と考えられる文書

様々なプロジェクトでそれぞれ異なったスタイルで文書が管理されている。

おそらく、ISOなどで定義されたものが最も公式な物と考えられるが、一般に浸透していない。

具体的な文書(今の所、順序は関係なく思いつくものを一通り書く)

文書体系図

文書体系を図にしたもの

ピラミッドの図で書くとどうやっても簡易的にしかならないので、実際には表を作る必要がある。

規約(この場合はこうするべきという統一指針)

ノウハウ

なぜそのような決定をしたのかという説明

設計書 (要件を満たすための設計)

目的から

マニュアル

基本的にエンティティが明確になる必要がある。

エンティティとなるもの

ハードウェア

ミドルウェア

機能

画面

帳票

ファイル

モジュール

API

通信プロトコル

データベース

スキーマ

テーブル

ビュー

シーケンス

アドレス

ポート

グループ

ユーザー

画面遷移図

UMLで使われる図

ユースケース図

システムの提供する機能とアクターの関係性

パッケージ図

システム構成要素のグルーピングと関係性

配置図

システムの物理的・論理的な位置付け

どこに何を置く、何と繋がる

コンポーネント図

クラス図

オブジェクト図

シーケンス図

時系列順の事象の説明

コラボレーション図(コミュニケーション図)

複数のオブジェクト間での事象発生の説明

ステートチャート図

オブジェクトの状態遷移

アクティビティ図

システム動作の流れ(フローチャート)

課題票

要望書

バグ票

「票」と「書」の使い分け

基本的に、紙1枚で済むような簡便な報告書型の物が「票」。元々は文字を書くための薄い木片のこと。「単票」とも呼ばれる。

それなりに長い文書になっている物が「書」

「表」は表形式(普通は行と列によるマトリクス形式)で書かれた物になる。「帳票」とも呼ばれる。