コンテンツにスキップ

DevBlueprint

Docsフォルダ

02. Docsフォルダ

Docs/フォルダは、このプロジェクトに関する全てのドキュメントを格納するメインフォルダです。このフォルダ内のドキュメントは、MkDocsによってビルドされ、GitHub Pagesのドキュメントサイトとして公開されます。

唯一の正しい情報源 (Single Source of Truth)

プロジェクトに関する仕様やルールは、全てこのDocs/フォルダ内に集約します。Wikiや個人のメモなど、情報が分散することは避けてください。

トップレベルの構成

Docs/フォルダ直下は、以下の目的別のカテゴリフォルダで構成されます。

Docs/
├── README.md                 # サイト全体のホームページ
│
├── 00_プロジェクト管理/      # プロジェクトの目標、計画、進捗を管理
├── 01_要求仕様/              # 「何を」作るかを定義
├── 02_設計仕様/              # 「どのように」作るかを定義
├── 03_開発ルール/            # 「どうやって」開発を進めるかの規約
├── 04_テスト仕様/            # 「どうやって」品質を保証するかを定義
│
└── assets/                   # 画像などの静的アセットを格納

各カテゴリフォルダの役割

`00_プロジェクト管理`

目的: プロジェクト全体の「進め方」と「目標」を管理します。
主な内容: ロードマップ、マイルストーン、進捗状況、変更履歴(CHANGELOG)など。

`01_要求仕様`

目的: プロジェクト全体の「何を」作るかを定義します。
主な内容: プロジェクトの全体仕様、機能ごとの詳細な要求、ユーザー視点でのユースケースなど。

`02_設計仕様`

目的: 要求仕様を「どのように」技術的に実現するかを詳細に記述します。
主な内容: UI/UX仕様、API仕様、データモデル設計、アーキテクチャ設計など、実装の設計図となる技術ドキュメント群です。

`03_開発ルール`

目的: 開発プロセスの一貫性と品質を保つための「お作法」を定義します。
主な内容: セットアップガイド、フォルダ構成（このドキュメント）、ブランチ戦略、コーディング規約など。

`04_テスト仕様`

目的: システムの品質を「どのように」保証するかを定義します。
主な内容: テスト計画、具体的なテストケース、テスト結果の報告などを管理します。

`assets`

目的: ドキュメント内で使用する画像、ロゴ、ファビコンなどの静的ファイルを格納します。