/Document-Template

開発ドキュメントのテンプレート集

Primary LanguageHTMLApache License 2.0Apache-2.0

Document-Template

開発ドキュメントのテンプレート





詳細




ドキュメントの種類

企画・受発注・準備

ドキュメント 内容
RFI(情報提供依頼書)
RFP(提案依頼書)
RFQ(見積依頼書)
要求定義書
システム仕様書

要件定義(要求分析) ~ 基本設計(外部設計) ~ 詳細設計(内部設計)

ドキュメント 内容
提案書 提案の背景 現状認識
現状の課題
導入目的
導入効果
導入における課題
実現方法
対象範囲・領域
提案システム システム構成 事業システム全体図
├ ビジネス機能関連図
└ ビジネス連携図
システム導入後の業務フロー
システムの前提条件
システムの範囲
プロジェクト管理 プロジェクトの進め方
成果物
開発体制
開発スケジュール
想定コスト
WBS
契約書
プロジェクト計画書 プロジェクト概要 プロジェクト概要
プロジェクトの目的
プロジェクトの課題 調査表(内部環境)
調査表(外部環境)
課題一覧表
プロジェクトの課題
ビジネス化目標定義書
目標(QCD;品質、費用、期限)
作業範囲(スコープ)
成果物
項目ごとのコスト 人件費
外注費
ソフトウェア費用
ハードウェア費用
インフラ/クラウド費用
保守費用
ライセンス費用
消耗品/備品費用
スケジュール・タスク WBS(抜粋)
V字モデル図
マイルストーン
体制図 自社側
顧客側
責任者・営業窓口
メンバーの役割
コミュニケーションルール 会議体(名称・参加者・目的・日程)
メールの宛先・件名・添付ファイル
チャットツールのテナント・チーム
議事録の書式・作成者
品質管理 品質管理基準
レビュー計画
テスト計画
文書管理ルール
リスクと対応方針 リスクの内容・発生確率・頻度・重要度
リスクへの対応方法
課題管理表
要件定義書 業務要件 目的・背景
基本設計書
詳細設計書(*)
ビジネスコンセプト SWOT
バランススコアカード(BSC)
ビジネスモデルキャンパス
ステークホルダ ステークホルダ関係図
ステークホルダ一覧
リッチピクチャ
要求分析 問題・ニーズ・課題一覧
問題原因分析図
要求構造図
要求一覧
データモデル 管理対象分類図
概念データモデル(ER 図)
ビジネスプロセスモデル 業務概要図
ビジネスプロセス関連図
業務機能構成表
ビジネスプロセスフロー(業務フロー)
システム化業務フロー
業務処理定義
相互作用モデル 状態遷移図
コミュニケーション 業務用語定義
ビフォーアフター図
機能要件 方式 ハードウェア構成
ソフトウェア構成
ネットワーク構成
システム化機能一覧表
システム機能階層
画面・帳票 画面一覧
帳票一覧
UI標準
画面遷移図
画面レイアウト
帳票概要
帳票レイアウト
画面入出力 *
画面アクション *
バッチ 帳票項目 *
帳票編集定義 *
バッチ処理一覧
バッチ処理フロー *
バッチ処理定義 *
インターフェース システム化要求仕様
外部インターフェース一覧
外部システム関連図
外部インターフェース定義
外部インターフェース処理定義 *
テーブル(データ定義) 概念データモデル(ER図)
エンティティ一覧 */ファイル一覧 *
エンティティ定義書/データ項目定義書 */ファイル定義 *
ドメイン定義
コード体系定義書/コード内容定義書 *
CRUD図 *
ファイル
非機能要件書 非機能要件 可用性 非機能要件書
機能性
運用性
保守性
移行性
セキュリティ
運用要件書 運用要件書



実装・単体テスト

ドキュメント 内容
単体テスト仕様書 テストケース テストケース概要 テスト仕様書兼結果報告書
前提条件
実行手順
入力値
期待値
デシジョンテーブル デシジョンテーブル
(条件分岐のパターンを列挙)
単体テスト結果報告書 単体テスト仕様書の項目
実行日、実行者
改修日
再実行日
課題管理表No



結合テスト

ドキュメント 内容
結合テスト仕様書 テストシナリオ テストシナリオ概要 テスト仕様書兼結果報告書
前提条件
実行手順
入力値
期待値
結合テスト結果報告書 結合テスト仕様書の項目
実行日、実行者
改修日
再実行日
課題管理表No



総合テスト(システムテスト)

ドキュメント 内容
総合テスト仕様書 総合テスト仕様書
総合テスト結果報告書
機能部分テスト 仕様書に記載された要件を満たしているか確認
大容量(ボリューム)テスト 大量データを扱えるか確認
ストレステスト 短時間に大量データを扱えるか確認
有用度テスト 人間的要因または有用どの問題を確認
・エンドユーザーのリテラシーに合わせて作られているか
・プログラムの出力は意味のあるものか
・エラーメッセージは意味のあるものか
・UIに一貫性があるか
・正確さが重要な箇所で入力に冗長性があるか
・使われそうにないオプションが含まれていないか
・すべての入力に対して即座にフィードバックを返しているか
・プログラムは使いやすいか
秘密保護(セキュリティ)テスト アプリケーションが安全であるか確認(脆弱性を検出するためのペネトレーションテストなど)
効率(パフォーマンス)テスト 平時の応答速度や処理速度を確認
記憶域(ストレージ)テスト メモリやストレージの容量の範囲内で利用できるか確認
構成テスト ハードウェア構成/ソフトウェア構成ごとの確認
互換性/構成/変換テスト 既存システムと互換性があるか、データ変換手順を確認
設置テスト 導入手順の確認
信頼性テスト MTBF や MTTR などの信頼性指標が達成されているか確認
回復テスト エラーから回復できるか確認
サービス性テスト 保守で使う診断プログラムなどのサービス機能を確認
文書テスト ユーザー文書の正確さを確認するために、ユーザー文書の記述に基づきいテストケースを作成して確認
手続きテスト 手作業による操作を確認



受入テスト

ドキュメント 内容
全体移行計画書(システム移行計画書) 全体移行計画書
受入テスト仕様書
検収書



運用

ドキュメント 内容
バグレポート




参考文献

官公庁

独立行政法人


Copyright (c) 2023 YA-androidapp(https://github.com/YA-androidapp) All rights reserved.