概要
プロジェクトの成果物が迷子にならないように、標準フォルダ階層と
命名ルール、版管理の考え方を示します。
下の表とツリーは編集・検索可能、さらに .bat / .sh の
自動生成ダウンロードで新規案件に即適用できます。
基本
- 番号+名称で並びが自明に(例:
05_詳細設計書)。 - 用途別・責務分離(要件/設計/試験/運用/管理)。
- 「外部提供」と「内部用」を分離。
- ゴミ箱は期限削除(自動/運用ルール併記)。
命名例:
YYMMDD_種別_短い説明_vMAJOR.MINOR(例:250815_設計_画面遷移_v1.3)
基礎(標準フォルダ一覧)
| No | フォルダ名 | 説明 |
|---|---|---|
| 01 | 受領資料 | 顧客から受け取った資料、参考資料、既存仕様書 |
| 02 | 要件定義書 | 要件定義、機能一覧、非機能要件、制約条件 |
| 03 | 基本設計書 | 画面遷移、IFマッピング、DB概念設計 |
| 04 | 申請 | 各種申請・承認依頼(権限・例外・変更等) |
| 05 | 詳細設計書 | 画面/帳票/バッチ/テーブル定義など詳細化 |
| 06 | 実装 | ソース、設定、スクリプト、インフラIaC定義 |
| 07 | 単体試験仕様書 | UT設計、ケース一覧、実施エビデンス |
| 08 | 結合試験仕様書 | IT設計、連携試験、シナリオテスト |
| 09 | 受入試験仕様書 | UATシナリオ、受入条件、顧客確認資料 |
| 10 | レビュー記録表 | レビュー議事録、指摘一覧、是正履歴 |
| 12 | 検討資料 | 要件や設計の検討中ドキュメント、比較表、調査結果 |
| 14 | 外部仕様書 | 顧客や外部システム向けのインタフェース仕様書 |
| 15 | 改訂履歴・版管理 | ドキュメント改訂表、版管理ポリシー |
| 18 | 契約関連 | 契約書、覚書、NDA、発注書 |
| 19 | 見積 | 概算見積、詳細見積、見積比較、根拠資料、見積依頼書・回答 |
| 20 | 試験 | 試験進行、進捗、総合エビデンス保管 |
| 22 | 性能試験 | パフォーマンス・負荷試験計画、結果、分析 |
| 23 | セキュリティ試験 | 脆弱性診断、ペネトレーションテスト結果 |
| 24 | システムテスト | システム全体のテスト計画、実施結果 |
| 25 | リグレッション試験 | 修正後の再試験、影響範囲確認、回帰試験計画と結果 |
| 26 | 品質管理 | 品質計画、チェックリスト、品質報告 |
| 27 | 監査資料 | 内部監査・外部監査用の証跡、報告書 |
| 30 | 内部課題 | 課題票、対応計画、完了報告、ふりかえり |
| 35 | 改善提案 | 業務・システム改善提案、効率化資料 |
| 40 | リリース関連 | リリース計画、手順、ロールバック、タグ命名 |
| 45 | 移行計画 | データ移行手順、検証結果、移行スクリプト |
| 50 | 運用・保守 | 運用手順、FAQ、障害/インシデント報告 |
| 55 | 障害対応 | 障害発生時の調査報告、再発防止策 |
| 80 | 教育・研修 | 教育資料、研修記録、オンボーディング |
| 85 | ナレッジベース | 手順書、ノウハウ集、事例共有 |
| 90 | 議事録 | 定例/顧客/社内会議の議事録と添付 |
| 91 | QA | 質問と回答、FAQ、問い合わせ履歴 |
| 92 | 報告書 | 進捗報告書、月次/週次レポート |
| 97 | 外部提供資料 | 顧客配布パッケージ、外部向け説明書 |
| 98 | 管理 | 計画、WBS、体制、契約、見積関連(社外秘分類注意) |
| 99 | ゴミ箱 | 削除予定の一時保管(自動削除ポリシー適用) |
一例(ツリー & 自動生成)
📁 ツリー表示(プレビュー)
⚙️ 自動生成スクリプト
Windows(.bat)
macOS/Linux(.sh)
※ ダウンロード後に内容を確認してから実行してください。社内規定のパス・権限設定に合わせて調整可能です。
最新情報(運用アップデート指針)
- クラウドストレージ統制:共有リンクの期限・閲覧範囲を自動で最小権限に。
- PII/社外秘タグ付け:機微度に応じた保管場所と権限をルール化。
- 自動アーカイブ:
99_ゴミ箱は N 日で削除、98_管理は年次でZIP保全。 - 命名の一貫性:CI/CDや文書ツールと連携し、版・日付・担当を自動付与。
- 監査ログ:変更履歴・DL履歴を保存し、改訂履歴・版管理 と紐付け。
規程やISMSと整合しない場合は、社内標準を優先して本ページのルールを微調整してください。
応用(プロジェクト特性ごとの拡張)
🧩 マイクロサービス
06_実装/サービス名配下にapi/workers/など。- 共通
libs/は独立管理、バージョン固定。
📱 モバイル
- ビルド成果物は
40_リリース関連/builds/に集約。 - 証明書・プロファイルは
98_管理/credentials/(権限厳格)。
🛡️ セキュリティ強化
- 機密度で分離保管。アクセスはグループベース。
- 外部提出は
97_外部提供資料のみから出す。
発展(自動化・メタデータ)
- ドキュメントの front‑matter(YAML/JSON)に
ownerstatusconfidentialityを付与。 - PR/レビュー完了で、該当の
10_レビュー記録表に自動追記。 - 定例議事録(
90)は発話→要点抽出→テンプレ反映を自動化。
# 例: docs/xx.md のfront-matter
---
title: "画面遷移設計 v1.3"
owner: "dev-team"
status: "approved"
confidentiality: "internal"
links:
- "../10_レビュー記録表/2025-08-12_設計レビュー.md"
---
テクニック(小ワザ集)
- ショートカット:
00_README.mdに各階層の目的/ルールを明記。 - 日付はISO:
YYYY-MM-DDを先頭にすると並びが安定。 - 粒度固定:月単位の深さを統一(例:議事録は
YYYY/MM/切り)。 - 同梱テンプレ:章立て済の
.docx/.mdテンプレを02/03/05に置く。
📄 フォルダ配下の初期README(雛形)
# 03_基本設計書
このフォルダは基本設計の成果物を管理します。
- 目的: 画面/IF/DBの基本設計を保存し、レビュー時に参照可能にする
- 更新責任: UI/IF/DB 各担当
- 命名規則: YYYYMMDD_種類_簡潔な説明_vX.Y
- 禁止事項: 個人情報の直接保存、機密の無暗号化
🧪 .gitignore(ドキュメントプロジェクト向け例)
# builds & temp
build/
tmp/
~$*.docx
.DS_Store
# private
98_管理/credentials/
99_ゴミ箱/