AI開発のためのドキュメント作成ルールを作る

# ドキュメント

このディレクトリには、プロジェクトの開発・運用に関するドキュメントが含まれています。

## 🗂️ Docs Naming Rules

## 🧭 **命名フォーマット**

```
[_prefix]-[main-topic].md
```

### ✅ Prefix一覧（カテゴリ別）

| Prefix       | レイヤー     | 意味・役割             | 例                                                   |
| ------------ | -------- | ----------------- | --------------------------------------------------- |
| `_arch-`     | 思想層（最上位） | 設計思想・原則・全体方針      | `_arch-guidelines.md`                               |
| `_guide-`    | 実行層（2番目） | 操作手順・実装ガイド・実務ノウハウ | `_guide-keyboard.md`, `_guide-font-installation.md` |
| `structure-` | 設計構造層    | フォルダ構成・設計ルール・命名体系 | `structure-directory.md`, `structure-guidelines.md` |
| `lint-`      | 例外・ルール層  | コード規約や例外設定        | `lint-exceptions.md`                                |
| `report-`    | 報告層      | 作業記録・移行レポート・結果報告  | `report-task-terminology-migration.md`              |
| `trouble-`   | 対応層      | 不具合・検証・原因分析       | `trouble-cursor-swift.md`                           |
| `README.md`  | 説明層（特例）  | フォルダ全体の概要         | `README.md`（プレフィックスなし）                              |

---

## 📚 **ファイル命名スタイル共通ルール**

| ルール                               | 内容                                                          |
| --------------------------------- | ----------------------------------------------------------- |
| 区切りは **ハイフン（-）**                  | 例：`_guide-keyboard.md` ✅ ／ `guide_keyboard.md` ❌            |
| すべて **小文字**                       | 例：`structure-guidelines.md` ✅ ／ `Structure-Guidelines.md` ❌ |
| 意味の中心は **英単語2〜3個以内**              | 冗長な説明語は避け、簡潔に                                               |
| 英単語順は「カテゴリ → 対象」                  | `guide-keyboard`（ガイド／キーボード）                                 |
| 特殊優先順序：`_arch-` → `_guide-` → その他 | 上に並ぶ順で意味的階層を表現する                                            |

---

## 📚 ドキュメント一覧

### 🏛️ 設計思想・アーキテクチャ
- [`_arch-guidelines.md`](./_arch-guidelines.md) - アーキテクチャガイドライン・設計原則

### 🔧 実装ガイド・手順書
- [`_guide-font.md`](./_guide-font.md) - フォント使用ガイドライン
- [`_guide-font-installation.md`](./_guide-font-installation.md) - Nunitoフォントのインストール手順
- [`_guide-keyboard.md`](./_guide-keyboard.md) - キーボード操作ガイドライン
- [`_guide-notifications-fg-bg.md`](./_guide-notifications-fg-bg.md) - フォアグラウンド・バックグラウンド通知ガイド
- [`_guide-quiet-moon-animation.md`](./_guide-quiet-moon-animation.md) - Quiet Moon状態からのSTART時アニメーション不発火問題の修正ガイド

### 🏗️ 構造・設計ルール
- [`structure-directory.md`](./structure-directory.md) - プロジェクトディレクトリ構造
- [`structure-guidelines.md`](./structure-guidelines.md) - コード構造ガイドライン

### ⚙️ 設定・例外・ルール
- [`lint-exceptions.md`](./lint-exceptions.md) - SwiftLint例外設定

### 📊 報告・記録
- [`report-task-terminology-migration.md`](./report-task-terminology-migration.md) - Task用語移行レポート

### 🔧 トラブルシューティング
- [`trouble-cursor-swift.md`](./trouble-cursor-swift.md) - Cursor Swift拡張のトラブルシューティング

## 📝 ドキュメント作成・更新ルール

### **ファイル命名規則**
- `_arch-*.md` - 設計思想・アーキテクチャガイドライン
- `_guide-*.md` - 実装手順・操作ガイド
- `structure-*.md` - 構造・設計ルール
- `lint-*.md` - コード規約・例外設定
- `report-*.md` - 作業記録・移行レポート
- `trouble-*.md` - トラブルシューティング
- `README.md` - フォルダ概要（プレフィックスなし）

### **更新時の注意**
1. 各ドキュメントの「更新履歴」セクションを必ず更新
2. このREADMEの「ドキュメント一覧」も併せて更新
3. 画像やコードサンプルは相対パスで参照
4. **命名ルール**に従ってファイル名を決定

### **コミット番号の記載方法**
ドキュメント内で関連するコミットを参照する際は、以下の形式を使用：

- **単一コミット**: ``Commit: `<hash>` - "<commit message>"``
  - 例: ``Commit: `ed3d217` - "Fix timer display issue: ensure initial value shows for full second"``
- **複数コミット**: リスト形式で記載
  - 例:
    ```markdown
    ## 🔗 関連コミット
    - Commit: `ed3d217` - "Fix timer display issue: ensure initial value shows for full second"
    - Commit: `a521704` - "Add report documenting timer initial display fix"
    ```
- **リリースノート**: コミット数を記載する場合
  - 例: `* **Commits:** 19`

**記載場所**:
- `report-*.md`: ドキュメント末尾の「関連コミット」セクションに主要なコミットを記載
- `releases/*.md`: 変更統計セクションにコミット数を記載
- `_guide-*.md`: 必要に応じて関連コミットを記載

## 🔗 関連リンク

### **プロジェクト情報**
- [メインリポジトリ](../) - プロジェクトルート
- [ソースコード](../App/) - アプリケーションコード

### **外部リソース**
- [SwiftUI公式ドキュメント](https://developer.apple.com/documentation/swiftui/)
- [Cursor公式ドキュメント](https://docs.cursor.sh/)

---

**💡 ヒント**: 新しいドキュメントを追加した際は、このREADMEも忘れずに更新してください！
**🏗️ ファイル名で意味的階層を表現し、「読む順序 = 理解の順序」を実現しています。