Home
Get Started
実践ガイド
外部仕様設計
バッチ処理仕様設計
UAC 仕様設計
データ仕様設計
インフラ設計
移行計画
テスト方針・計画
開発プロセス・規約
基本設計書 改訂履歴
基本設計書の変更履歴を体系的に記録し、ドキュメントの信頼性と透明性を確保します。
🎯 概要
- 目的: 基本設計書の変更履歴を記録し、いつ・誰が・何を変更したかを追跡可能にすることで、ドキュメントの信頼性と透明性を確保する
- スコープ: 基本設計書の版管理、改訂日、改訂者、変更内容の記録を対象とする。レビュー指摘事項や承認プロセスとの連携も含む
- 推奨する実施タイミング: 基本設計書の初版作成時から記録を開始し、以降すべての変更時に更新する
- 関連するステークホルダー: プロジェクトマネージャー、設計担当者、レビュアー、承認者
📥 重要な前提知識・インプット
- 前提知識: ドキュメント版管理の基本、変更管理プロセス、レビュー・承認フローの理解
- インプット: レビュー指摘事項、変更依頼、承認記録、前版の改訂履歴
📄 成果物の定義
- ドキュメントテンプレート: 📄
[テンプレ] 改訂履歴
- 必須要素: 版数、改訂日、改訂者名、変更内容の簡潔な説明、関連する指摘事項や承認記録へのリンク
✅ 品質基準・レビュー観点
✅ 品質チェックリスト:
| チェック項目 | チェック内容 |
|---|---|
| 記録の完全性 | すべての変更が漏れなく記録されている |
| 版番号の一貫性 | 版番号が規則に従って連番で付与されている |
| 変更内容の明確性 | 変更内容が第三者にも理解できる表現になっている |
| トレーサビリティ | レビュー指摘や変更依頼への参照が適切に記載されている |
👁️🗨️ レビュー観点:
- 記録の正確性: 改訂日、改訂者、版番号が正確に記録されているか
- 変更内容の適切性: 変更内容の説明が具体的で、後から追跡可能か
- リンクの有効性: 関連資料へのリンクが正しく機能するか
- 版管理ルールの遵守: プロジェクトの版管理ルール(メジャー/マイナー版の使い分けなど)に従っているか
🧪成果物のサンプル
## 改訂履歴
| 版数 | 改訂日 | 改訂者 | 変更内容 |
| :--- | :----------- | :--------- | :----------------------------------------- |
| 0.1 | 2025/11/20 | 〇〇 太郎 | 初版作成 |
| 0.9 | 2025/12/01 | 〇〇 太郎 | 顧客レビュー指摘事項反映。詳細:https://...|
| 1.0 | 2025/12/06 | 〇〇 太郎 | 最終承認版 |
--- 🔄 進め方・プロセス
📝 プロセス1: 初版の改訂履歴作成
記録対象:
基本設計書を新規作成した際の初版情報を改訂履歴に記録する。
具体例:
- 版数: 0.1 または 1.0(プロジェクトの版管理ルールに従う)
- 改訂日: ドキュメントを作成した日付
- 改訂者: ドキュメント作成者の氏名
- 変更内容: 「初版作成」または「新規作成」
記録原則:
- タイムリーな記録: ドキュメント作成と同時に改訂履歴を記録し、後回しにしない
- 版番号ルールの確認: プロジェクトで定められた版管理ルール(初版を0.1とするか1.0とするか)を確認して従う
- 作成者の明記: 誰が作成したかを明確にし、後で質問できるようにする
文書化の推奨表現:
- 表形式で記録し、列は「版数」「改訂日」「改訂者」「変更内容」を最低限含める
- 改訂日は年/月/日形式で統一する
- 変更内容は簡潔に記載する
📝 プロセス2: レビュー指摘反映時の改訂履歴更新
記録対象:
レビューで受けた指摘事項を反映し、ドキュメントを更新した際の改訂情報を記録する。
具体例:
- 版数: 0.2、0.3などマイナーバージョンアップ
- 改訂日: レビュー指摘を反映した日付
- 改訂者: 指摘を反映した担当者の氏名
- 変更内容: 「顧客レビュー指摘事項反映」「社内レビュー指摘事項反映。詳細: [レビュー記録へのリンク]」
記録原則:
- トレーサビリティの確保: レビュー記録や指摘一覧へのリンクを含め、どの指摘に対応したか追跡可能にする
- 変更箇所の明示: 主要な変更内容を簡潔に記載し、詳細は別資料を参照できるようにする
- 版番号の適切な使い分け: 軽微な修正はマイナーバージョン、大きな変更はメジャーバージョンを上げる
文書化の推奨表現:
- 変更内容には「〇〇レビュー指摘事項反映」と記載し、レビュー記録へのリンクを追加
- 複数のレビューを経る場合は、それぞれの反映時に別行で記録
📝 プロセス3: 承認版の改訂履歴更新
記録対象:
正式な承認を得て、ドキュメントが確定版となった際の改訂情報を記録する。
具体例:
- 版数: 1.0、2.0などメジャーバージョン
- 改訂日: 承認を得た日付
- 改訂者: 最終更新を行った担当者の氏名
- 変更内容: 「最終承認版」「正式版」「顧客承認済み版」
記録原則:
- 承認の明示: 承認を得たことを明確に記載し、承認記録へのリンクを含める
- メジャーバージョンの適用: 正式承認版はメジャーバージョン(1.0、2.0など)とする
- 基準版としての位置づけ: この版が以降の変更の基準となることを意識する
文書化の推奨表現:
- 変更内容に「最終承認版」または「正式版(第〇版)」と明記
- 承認者や承認日の情報を含められる場合は追記する
📝 プロセス4: 継続的な改訂履歴の保守
記録対象:
ドキュメントのライフサイクル全体を通じて、すべての変更を継続的に記録する。
具体例:
- 軽微な誤記修正、用語の統一、図の差し替えなども記録対象
- 版数は変更の規模に応じて適切に付与
- 変更理由や背景を簡潔に記載
記録原則:
- すべての変更を記録: 小さな変更も含めてすべて記録し、履歴の完全性を保つ
- 変更理由の明記: なぜ変更したのか(誤記修正、要件変更、技術変更など)を記載
- 最新版の明確化: 現時点での最新版がどれかが一目でわかるようにする
文書化の推奨表現:
- 改訂履歴は時系列順(新しいものが上、または下)に統一して記載
- 変更内容の粒度は、後から見て変更の経緯が理解できる程度に記載
🚨 よくある失敗と予防策
🚧 実例収集後、追記予定
📚 参考資料・関連リンク
- 参考文献: プロジェクトの版管理規約、ドキュメント管理ガイドライン
- 関連する他のガイド: レビュー承認記録、品質チェックリスト、リリースノート作成ガイド
- ツール・テンプレート: 改訂履歴テンプレート、版番号付与ルール
テンプレートサイト: 📄テンプレート集