Newer
Older
PixelPaintWar / docs / 02_Guide / GUIDE_02_ファイル命名規則.txt
========================================================================
ドキュメント管理・ファイル命名規則 (File Naming Conventions)
========================================================================

1. 命名の基本方針 (Basic Policy)
------------------------------------------------------------------------
プロジェクトの規模拡大に伴うファイルの散乱を防ぎ,開発メンバーおよびAI(Gemini/Copilot)がファイルの内容・文脈を即座に特定できるようにするため,以下の規則を適用する.

■ 基本フォーマット
`[カテゴリ]_[連番]_[ファイル名].txt`

・区切り文字: アンダースコア `_` を使用する.
・連番: 01から始まる2桁の数字とする.
・拡張子: プレーンテキスト `.txt` とする.


2. カテゴリ定義 (Category Definitions)
------------------------------------------------------------------------
ファイル名の先頭に付与するプレフィックス(接頭辞)定義.

■ GUIDE_ (Guide)
・内容: チーム全体のルール,規約,運用フローなど,「メタ情報」に関する定義.
・対象例: スタイルガイド,命名規則,Git運用ルール.

■ PLAN_ (Planning)
・内容: プロジェクトの進行計画,スケジュール,要件定義など,「管理・進行」に関する定義.
・対象例: WBS,ロードマップ,要件定義書,タスク一覧.

■ ENV_ (Environment)
・内容: 開発環境,ディレクトリ構造,ライブラリ選定など,プロジェクトの「土台」に関する定義.
・対象例: 環境構築手順,技術スタック一覧,パッケージ構成図.

■ SPEC_ (Specification)
・内容: 企画,ゲームルール,UI/UXなど,ユーザーから見える「仕様」に関する定義.
・対象例: ゲーム企画書,画面遷移図,パラメータ設定(マップサイズ・速度など).

■ TECH_ (Technical)
・内容: 実装詳細,アルゴリズム,データ構造など,エンジニア向けの「技術設計」に関する定義.
・対象例: 通信プロトコル仕様,同期ロジック,データベース設計,クラス設計.

■ TEST_ (Test)
・内容: テスト計画,テストケース,品質保証手順など,「検証・品質」に関する定義.
・対象例: 単体テスト仕様書,シナリオテスト計画,テストケース一覧,品質基準.


3. 運用ルール (Operational Rules)
------------------------------------------------------------------------
・1ファイル1テーマ:
    ファイルサイズが肥大化しすぎないよう,トピック(例: 通信仕様,判定ロジック)ごとにファイルを分割することを推奨する.
    これにより,AIへのコンテキスト入力精度が向上する.

・スタイルの継承:
    新規作成するファイルも,必ず `GUIDE_01_スタイルガイド.txt` に記載された書式(見出し,句読点「,.」等)に従うこと.