ドキュメントの管理方法
あのドキュメントはどこにあったっけ？
ドキュメントを作ったけどどこに保存すればいいの？
ドキュメント類はプロジェクトが進むにつれて散在しがちです。
弊社でも開発の中でこのようなことが多々ありましたが、
現在は開発リソース（ドキュメント等）の管理を「プロジェクト様式」として、以下のようなフォルダ構成で行っております。
ドキュメントの管理例
カッコ内はPocketDOCでダウンロードできるテンプレート・ドキュメントのリンクです。
10.要求 ( 要求仕様書 )- 20.見積 ( 御見積書・御見積書(簡易版) )
- 30.設計
- 10.設計方式 ( ドキュメント作成基準書・ネーミング基準書(DB)・設計方式書(APL) )
- 20.基本設計
- 10.システム構成 ( システム構成図 )
- 20.業務フロー ( 業務フロー図 )
- 30.機能設計 ( 機能一覧; )
- 40.画面設計 ( 画面レイアウト・画面一覧・画面遷移図 )
- 50.帳票設計 ( 帳票レイアウト(横)・帳票レイアウト(縦)・帳票一覧 )
- 60.バッチ設計 ( ジョブネット図・バッチ一覧 )
- 70.DB設計 ( ER図・シーケンス一覧・テーブル定義書・ユーザ一覧・表領域一覧 )
- 80.IF設計 ( IFファイル定義書 )
- 30.詳細設計
- 10.○○機能 ( 詳細設計書 )
- 40.開発
- 10.開発方式 ( コーディング基準書(ASP・SQL・VB) )
- 20.開発環境 ( 現在ありません )
- 30.プロトタイプ ( 現在ありません )
- 40.Source ( 現在ありません )
- 50.セットアップ ( 現在ありません )
- 60.切替 ( 現在ありません )
- 50.試験
- 10.試験方式 ( 試験方式書 )
- 20.単体試験
- 1.試験仕様書 ( 単体試験仕様書 )
- 2.結果報告書 ( 試験結果を格納します )
- 30.結合試験
- 1.試験仕様書 ( 結合試験仕様書 )
- 2.結果報告書 ( 試験結果を格納します )
- 40.総合試験
- 1.試験仕様書 ( 総合試験仕様書 )
- 2.結果報告書 ( 試験結果を格納します )
- 50.障害管理 ( 障害一覧・障害管理票 )
- 60.マニュアル
- 10.運用マニュアル ( 現在ありません )
- 20.ユーザマニュアル ( マニュアル(一般ユーザ用) )
- 70.納品物
- YYYYMMDD ( 日付ごとに納品物を格納します )
- 80.管理
- 10.スケジュール( 全体スケジュール )
- 20.体制( 体制図 )
- 30.議事録( 打合せ議事録 )
- 40.QA( QAシート )
- 50.借用書・貸出書( 物品借用書・物品貸出書 )
- 60.誓約書( 外注誓約書 )
- 70.納品書・受領書・検収書( ソフトウェア検収書・受領書・納品書 )
- 80.個人情報管理台帳( 個人情報取扱い管理票 )
- 90.勤務表( 現在ありません )
- 90.その他
- 10.ワーク( 一時的なファイルを格納します )
- 20.引継資料( 引継資料を格納します )
ドキュメント支援ツール
テンプレートやドキュメントのヘッダー、フッター一括変換ツール
ドキュメントのダウンロード後、実際に運用していく中で一番面倒なのは、
ドキュメントのヘッダーやフッター情報の置換ではないでしょうか。
WordやExcelを1つずつ開いて修正するのは時間もかかる上に誤字脱字なども起こりやすくなります。
PocketDOCでは、これらのヘッダー・フッターを一括で変換できる便利な支援ツールを用意しております。
変換したいプロパティ情報、フッター情報を設定するだけ！後は実行ボタンを1つクリックするだけです！
またツールはオープンソースなので、プロジェクト内でカスタマイズなども自由にできます！
この支援ツールは「テンプレートやドキュメントのヘッダー、フッター一括変換ツール」にてダウンロード可能です。
開発支援ツール( Excelアドイン )
PocketDOCを利用した「Oracle」「SQLServer」「MySQL」「PostgreSQL」向けの開発支援ツールです。
各種データベースにあわせたDDL、Entity、データを作ることが可能なので大変便利です。
Excelのアドインとして登録できるので、わずらわしいインストール作業なども発生しません。
現在、Excelアドインツールは以下のテンプレート・ドキュメントで使用することが可能です。
・テーブル定義書
・表領域一覧
・ユーザ一覧
・シーケンス一覧
・IFファイル定義書
またツールはオープンソースなので、プロジェクト内でカスタマイズなども自由にできます！
この支援ツールは「開発支援ツール( Excelアドイン )」にてダウンロード可能です。
ダウンロードランキング
ダウンロードランキング
※ 2007年7月末時点でのランキングです。
| 順位 | ドキュメント | % |
| 1 | 要求仕様書 | 3.1 |
| 2 | 詳細設計書 | 2.8 |
| 3 | システム構成図 | 2.7 |
| 4 | 業務フロー図 | 2.6 |
| 5 | 機能一覧 | 2.5 |
| 6 | 画面レイアウト | 2.5 |
| 7 | 画面遷移図 | 2.4 |
| 8 | 単体試験仕様書 | 2.4 |
| 9 | 画面一覧 | 2.4 |
| 10 | ドキュメント作成基準書 | 2.4 |
| 11 | テーブル定義書 | 2.3 |
| 12 | ER図 | 2.2 |
| 13 | 結合試験仕様書 | 2.2 |
| 14 | シーケンス一覧 | 2.2 |
| 15 | 総合試験仕様書 | 2.1 |
| 16 | 全体スケジュール | 2.1 |
| 17 | ソフトウェア検収書 | 2.1 |
| 18 | 試験方式書 | 2.1 |
| 19 | ネーミング基準書(DB) | 2.1 |
| 20 | ジョブネット図 | 2.1 |
| 21 | 設計方式書(APL) | 2.1 |
| 22 | IFファイル定義書 | 2.1 |
| 23 | 帳票レイアウト(横) | 2.1 |
| 24 | バッチ一覧 | 2.1 |
| 25 | 帳票一覧 | 2.1 |
| 26 | 障害一覧 | 2.0 |
| 27 | 設計方式書(DB) | 2.0 |
| 28 | 障害管理票 | 2.0 |
| 29 | 帳票レイアウト(縦) | 2.0 |
| 30 | 打合せ議事録 | 2.0 |
| 31 | マニュアル(一般ユーザ用) | 1.9 |
| 32 | ユーザ一覧 | 1.9 |
| 33 | 表領域一覧 | 1.9 |
| 34 | 体制図 | 1.9 |
| 35 | コーディング基準書(VB) | 1.9 |
| 36 | QAシート | 1.9 |
| 37 | 納品書 | 1.8 |
| 38 | コーディング基準書(SQL) | 1.8 |
| 39 | 御見積書 | 1.8 |
| 40 | コーディング基準書(ASP) | 1.8 |
| 41 | 物品借用書 | 1.7 |
| 42 | 受領書 | 1.7 |
| 43 | テンプレートやドキュメントのヘッダ、フッタ一括変換ツール | 1.7 |
| 44 | 物品貸出書 | 1.7 |
| 45 | 開発支援ツール( Excelアドイン ) | 1.7 |
| 46 | 外注誓約書 | 1.6 |
| 47 | 個人情報取扱い管理票 | 1.6 |
| 48 | 御見積書(簡易版) | 1.6 |