01. フォルダ構成

このフォルダには、DevBlueprintリポジトリ全体のフォルダ構成と、それぞれの要素が持つ役割について説明するドキュメントが格納されています。

一貫したフォルダ構成は、プロジェクトの全体像の理解を助け、必要な情報への迅速なアクセスを可能にします。

このカテゴリに含まれるドキュメント

このカテゴリのドキュメントを読むことで、リポジトリ内の各フォルダや主要なファイルが「なぜそこにあるのか」を理解できます。

01.ルートディレクトリ
- リポジトリの一番上の階層にある、.github/, Docs/, mkdocs.ymlといった、主要なファイルとフォルダの役割について説明します。
02.Docsフォルダ
- 全てのドキュメントソースが格納される、このプロジェクトの中核となるDocs/フォルダの内部構成について説明します。
03.Srcフォルダ
- アプリケーションのソースコードを格納するSrc/フォルダの、標準的な構成パターンについて説明します。
04.Testsフォルダ
- 自動テストコードを格納するTests/フォルダの、標準的な構成パターンについて説明します。
05.Sandboxフォルダ
- 実験的なコードやアイデアの試作を行うための「砂場」であるSandbox/フォルダの、目的と利用ルールについて説明します。

Tip

新しいプロジェクトでこのDevBlueprintテンプレートを利用する際は、まずこの「フォルダ構成」のドキュメントに目を通し、全体像を把握することをお勧めします。