Newer
Older
MiniTias / docs / 01_GUIDE / GUIDE_03_ファイル命名規則.md

ドキュメント管理・ファイル命名規則 (File Naming Conventions)

命名の基本方針 (Basic Policy)

プロジェクトの規模拡大に伴うファイルの散乱を防ぎ,開発メンバーおよび AI がファイルの内容・文脈を即座に特定できるようにするため,以下の規則を適用する.

基本フォーマット

[カテゴリ]_[連番]_[ファイル名].md

  • 区切り文字: アンダースコア _ を使用する.
  • 連番: 01 から始まる 2 桁の数字とする.
  • 拡張子: マークダウン .md とする.

カテゴリ定義 (Category Definitions)

ファイル名の先頭に付与するプレフィックス(接頭辞)定義.

カテゴリディレクトリ内容対象例
GUIDE_01_GUIDE/ルール,規約,運用フロースタイルガイド,命名規則,Git 運用ルール
ENV_02_ENV/開発環境,プロジェクトの土台環境構築手順,技術スタック一覧,パッケージ構成図
PLAN_03_PLAN/進行計画,スケジュール,要件定義WBS,ロードマップ,要件定義書,タスク一覧
SPEC_04_SPEC/ユーザーから見える仕様企画書,画面遷移図,パラメータ設定
TECH_05_TECH/エンジニア向けの技術設計通信プロトコル仕様,データベース設計,クラス設計
TEST_06_TEST/テスト計画,品質保証単体テスト仕様書,シナリオテスト計画,品質基準

運用ルール (Operational Rules)

  • 1 ファイル 1 テーマ: ファイルサイズが肥大化しすぎないよう,トピックごとにファイルを分割することを推奨する.これにより,AI へのコンテキスト入力精度が向上する.
  • スタイルの継承: 新規作成するファイルも,必ず GUIDE_02_ドキュメント作成ガイド に記載された書式に従うこと.