@aramassa/ai-rules 0.9.9 → 0.9.11

package/artifact/codex/planning.md

@@ -0,0 +1,552 @@
+---
+type: prompt
+category: project-planning
+focus: implementation-planning
+description: "OpenAI CodexWeb 向け実装計画作成プロンプト。todo_plans/ 配下に詳細な計画ファイルを出力する。"
+agent: codex
+---
+
+## 実装計画作成プロンプト（CodexWeb 向け）
+
+### 概要
+
+このプロンプトは、OpenAI の CodexWeb で新機能や改善の実装計画を作成するためのものです。計画フェーズのうち、`todo_plans/` へのファイル出力のみを実施します。GitHub Issue の起票やブランチ作成は対象外です。
+
+なお、この手順が実施するのは
+
+* `todo_plans/` 以下への作業計画の出力のみ
+
+であって、以下のいずれも、いかなる場合においても `todo_plans/` 以外への変更を実施してはいけません。
+
+### 目的
+
+対象リポジトリを分析し、以下のファイルを `todo_plans/` 配下に出力します：
+
+| ファイル名 | 必須 | 役割 |
+|-----------|------|------|
+| `index.md` | ✅ | 3行要約。後に Issue 本文と同期する正本 |
+| `details.md` | ✅ | 詳細な実装計画（背景、Phase、受け入れ基準等） |
+| `e2e-cmd.md` | ✅ | E2E コマンドラインテスト計画 |
+| `testing.md` | 任意 | テスト戦略・テストケースの詳細 |
+| `risks.md` | 任意 | リスク評価と対策の詳細 |
+| `notes.md` | 任意 | 設計メモ・その他補足 |
+
+### 前提条件
+
+- 実装したい機能・改善の概要が明確になっている
+- 対象リポジトリにアクセスできる
+- GitHub Issue はまだ作成されていない（仮のディレクトリ名を使用）
+
+### 出力先ディレクトリ
+
+Issue 番号が未確定のため、以下の仮ディレクトリを使用します：
+
+```
+todo_plans/YYYYMMDD-temp-[descriptive-name]/
+├── index.md      # 必須: 3行要約
+├── details.md    # 必須: 詳細実装計画
+├── e2e-cmd.md    # 必須: E2Eテスト計画
+├── testing.md    # 任意: テスト戦略詳細
+├── risks.md      # 任意: リスク評価詳細
+└── notes.md      # 任意: 設計メモ
+```
+
+**例**: `todo_plans/20260101-temp-cli-recipe-option/`
+
+Issue 起票後に `todo_plans/${IssueNumber}/` へリネームします。
+
+---
+
+## 実行タスク
+
+### Phase 1: コンテキスト収集（要件明確化）
+
+対象リポジトリを調査し、実装に必要な情報を収集します。
+
+#### 1-1. 5W1H 分析
+
+以下の観点で要件を明確化してください：
+
+- **Why（なぜ）**: この機能が必要な背景・課題
+- **What（何を）**: 実装する機能の具体的な内容
+- **Who（誰が）**: 対象ユーザー・ステークホルダー
+- **When（いつ）**: 時間的制約・優先度
+- **Where（どこで）**: 影響を受けるモジュール・ファイル
+- **How（どのように）**: 技術的なアプローチ
+
+#### 1-2. 既存コードベースの調査
+
+```
+# 推奨する調査手順
+
+1. プロジェクト構造の把握
+   - README.md、package.json 等を確認
+   - ディレクトリ構造を把握
+
+2. 関連コードの特定
+   - 変更対象のファイルを特定
+   - 既存の類似実装パターンを確認
+
+3. テストコードの確認
+   - 既存のテスト構造を把握
+   - テスト対象範囲を特定
+
+4. ドキュメントの確認
+   - 既存のドキュメント構造を確認
+   - 更新が必要なドキュメントを特定
+```
+
+#### 1-3. 品質チェック
+
+- [ ] 背景と課題が具体的に説明できる
+- [ ] 成功基準が測定可能である
+- [ ] 制約条件が網羅されている
+
+### Phase 2: 技術調査・分析
+
+実装可能性と技術的リスクを評価します。
+
+#### 2-1. システム影響分析
+
+```
+# 確認すべき項目
+
+1. 影響を受けるファイル一覧
+   - 変更が必要なファイル
+   - 新規作成が必要なファイル
+
+2. 影響を受けないファイル
+   - 変更不要だが関連するファイル
+
+3. 依存関係
+   - 内部依存（他モジュール）
+   - 外部依存（パッケージ）
+```
+
+#### 2-2. 技術的選択肢の検討
+
+- 既存パターンとの整合性
+- パフォーマンスへの影響
+- 保守性・拡張性
+
+#### 2-3. 品質チェック
+
+- [ ] 影響範囲が特定されている
+- [ ] 技術的選択肢が比較検討されている
+- [ ] リスクが評価されている
+
+### Phase 3: 実装計画策定
+
+具体的で実行可能な計画を作成します。
+
+#### 3-1. タスク分解（WBS）
+
+各タスクは **2-3時間で完了する規模** に分割してください（Small Batch 原則）。
+
+```
+# Phase 分割の目安
+
+Phase 1: 必須機能（2-3時間）
+  - 最小限の動作確認が可能な状態
+
+Phase 2: 拡張機能（2-3時間）
+  - 利便性向上、オプション追加
+
+Phase 3: テスト（1-2時間）
+  - ユニットテスト、統合テスト
+
+Phase 4: ドキュメント（1-2時間）
+  - README、使用例、API ドキュメント
+
+Phase 5: 統合・検証（1時間）
+  - E2E テスト、最終確認
+```
+
+#### 3-2. 実装順序の決定
+
+依存関係を考慮し、論理的な実装順序を決定してください。
+
+#### 3-3. 品質チェック
+
+- [ ] タスクが適切に分解されている
+- [ ] 実装順序が論理的である
+- [ ] 工数見積もりが現実的である
+
+### Phase 4: 品質保証・レビュー
+
+プランの妥当性と品質を確保します。
+
+#### 4-1. 完全性チェック
+
+**要件定義の完全性**:
+- [ ] すべてのステークホルダーが特定されている
+- [ ] 機能要件・非機能要件が明確である
+- [ ] 制約条件が網羅されている
+- [ ] 前提条件が明記されている
+
+**実装計画の詳細度**:
+- [ ] タスクが実行可能なレベルまで分解されている
+- [ ] 各タスクの成果物が明確である
+- [ ] 依存関係が正確に把握されている
+- [ ] 工数見積もりが根拠とともに示されている
+
+**テスト戦略の包括性**:
+- [ ] テストケースの方針が明確である
+- [ ] E2E テスト計画が作成されている
+- [ ] 受け入れ基準が検証可能である
+
+---
+
+## 出力ファイル仕様
+
+### index.md テンプレート
+
+```markdown
+# 変更概要（3行）
+- [変更内容1]
+- [変更内容2]
+- [変更内容3]
+
+## 対象
+- パッケージ/モジュール: [対象名]
+
+## 動作確認
+- [確認方法]
+
+## 稼働中システムへの影響
+- [影響の有無と内容]
+
+## 破壊的変更
+- なし / あり（内容: ）
+
+## 計画ファイル一覧
+- `index.md`: この Issue 本文（要点のみ）
+- `details.md`: 実装の詳細（背景、実装方針、Phase、受け入れ基準など）
+- `e2e-cmd.md`: E2E コマンドラインテスト計画
+
+## 関連ファイルの記載ルール
+
+計画ファイル内で関連ファイルやディレクトリを参照する場合は、**必ずプロジェクトルートからのフルパス**で記載してください。
+
+**良い例**:
+- `packages/core/src/index.ts`
+- `todo_plans/123/index.md`
+
+**悪い例**:
+- `index.ts`（どのパッケージか不明）
+- `./index.md`（現在のディレクトリが不明確）
+```
+
+### details.md テンプレート
+
+```markdown
+# [機能名] 実装計画
+
+## 背景
+
+### 現状の課題
+- [課題1]
+- [課題2]
+- [課題3]
+
+### 解決策
+[提案する解決アプローチを記述]
+
+## やること
+
+### Phase 1: [フェーズ名]（必須機能）
+- [ ] タスク1
+- [ ] タスク2
+
+### Phase 2: [フェーズ名]（拡張機能）
+- [ ] タスク1
+- [ ] タスク2
+
+### Phase 3: [フェーズ名]（テスト）
+- [ ] タスク1
+- [ ] タスク2
+
+### Phase 4: [フェーズ名]（ドキュメント）
+- [ ] タスク1
+- [ ] タスク2
+
+## 要件分析
+
+### ユーザーストーリー
+
+**US-1: [ストーリータイトル]**
+```
+AS A [ユーザー種別]
+I WANT TO [やりたいこと]
+SO THAT [目的]
+```
+
+**受け入れ基準**:
+- [ ] 基準1
+- [ ] 基準2
+
+### 技術的制約
+
+#### TC-1: [制約名]
+[制約内容の説明]
+
+## アーキテクチャ設計
+
+### システム影響範囲
+
+#### 影響を受けるファイル
+- ✅ **変更**: [ファイルパス]（変更内容）
+- ✅ **新規**: [ファイルパス]（用途）
+
+#### 影響を受けないファイル
+- [ファイルパス1]
+- [ファイルパス2]
+
+### データフロー設計
+
+```mermaid
+graph LR
+    A[入力] --> B[処理1]
+    B --> C[処理2]
+    C --> D[出力]
+```
+
+### インターフェース設計
+
+```typescript
+interface FeatureConfig {
+  // 型定義
+}
+```
+
+## 実装計画
+
+### 改修対象ファイル一覧
+
+```
+packages/[パッケージ名]/
+├── ファイル1          # 変更内容
+├── ファイル2          # 変更内容
+└── ファイル3          # 変更内容
+```
+
+### ファイルごと改修内容
+
+#### 1. [ファイルパス]
+
+**変更内容**:
+```typescript
+// コード例
+```
+
+**理由**: [変更の理由]
+
+### 実装順序
+
+#### Step 1: [ステップ名]
+1. タスク1
+2. タスク2
+
+## 実装後の挙動
+
+### 基本的な使用例
+
+```bash
+# 使用例
+```
+
+### エラーケース
+
+```bash
+# エラー例
+```
+
+## 品質保証
+
+### テスト戦略
+
+#### Unit Tests
+[単体テストの方針]
+
+#### Integration Tests
+[統合テストの方針]
+
+### 動作確認項目
+
+#### 必須確認項目
+- [ ] 確認項目1
+- [ ] 確認項目2
+
+## リスク評価と対策
+
+### 技術リスク
+
+#### R-1: [リスク名]
+**リスク**: [リスクの説明]
+**対策**: [対策の説明]
+**影響度**: 高/中/低
+
+## 関連ドキュメント
+- [関連する計画書やドキュメント]
+
+## メモ
+
+### 設計の参考
+[参考にした情報源]
+
+### 将来的な拡張案
+- [ ] 拡張案1
+- [ ] 拡張案2
+
+---
+
+**作成日**: YYYY年MM月DD日
+**ステータス**: 計画中
+```
+
+### e2e-cmd.md テンプレート
+
+```markdown
+# E2E テスト計画: [機能名]
+
+## 基本原則
+
+E2E テストは、**コマンドライン上で完結するもののみ**を対象とします。
+
+## 追加すべきテスト
+
+### テスト1: [テスト名]
+
+- **目的**: [何を検証するか]
+- **対象ファイル**: [プロジェクトルートからのフルパス]
+- **コマンド**:
+  ```bash
+  # セットアップ
+  npm run build
+
+  # テスト実行
+  ./dist/cli.js command --option value
+
+  # 期待する結果
+  # - 終了コード: 0
+  # - 標準出力: "Success message"
+  ```
+- **検証ポイント**:
+  - [ ] 終了コードが正しい
+  - [ ] 標準出力/標準エラー出力が期待通り
+  - [ ] ファイル生成が正しく行われる
+
+### テスト2: [エラーケーステスト名]
+
+- **目的**: [エラー時の挙動を検証]
+- **対象ファイル**: [プロジェクトルートからのフルパス]
+- **コマンド**:
+  ```bash
+  # エラーケース実行
+  ./dist/cli.js command --invalid-option ; echo "exit code: $?"
+
+  # 期待する結果
+  # - 終了コード: 1
+  # - 標準エラー出力: エラーメッセージ
+  ```
+- **検証ポイント**:
+  - [ ] 終了コード 1
+  - [ ] エラーメッセージが適切
+
+## 更新すべきテスト
+
+### テスト3: [既存テスト名]
+
+- **現在の問題**: [なぜ更新が必要か]
+- **対象ファイル**: docs-ai/e2e-test/[既存ファイル名]
+- **変更内容**:
+  - 変更前: `old command`
+  - 変更後: `new command --new-option`
+- **理由**: [変更理由]
+
+## 削除すべきテスト
+
+なし / あり（ある場合は以下に記載）
+
+### テスト4: [削除するテスト名]
+
+- **対象ファイル**: docs-ai/e2e-test/[ファイル名]
+- **削除理由**: [なぜ不要になったか]
+
+## コマンド記述の注意点
+
+1. **絶対パスを使用**: プロジェクトルートからの明示的なパス
+2. **環境変数を明示**: 必要な環境変数は明記
+3. **前提条件を記載**: セットアップ手順を含める
+4. **期待結果を明記**: 終了コード、出力内容を記載
+5. **クリーンアップを含める**: 必要に応じて後処理を記載
+
+## 関連ドキュメント
+
+- E2E テストガイドライン: `artifact/instructions/rules/test/e2e-cmd.md`
+- E2E テストディレクトリ: `docs-ai/e2e-test/`
+```
+
+---
+
+## 品質基準
+
+### 良い計画書の特徴
+
+- **具体的**: 実装イメージが明確
+- **測定可能**: 完了条件が明確
+- **実現可能**: 技術的制約を考慮
+- **段階的**: Phase 分けされている（3-5 Phase）
+- **テスト可能**: 検証方法が明確
+
+### 良い計画例
+
+```markdown
+## やること
+
+### Phase 1: 基本機能（2-3時間）
+1. **--recipe オプションの追加**
+   - CLI オプションとして recipe フラグを追加
+   - ExtractOptions インターフェースに recipeFile プロパティを追加
+
+2. **YAML ファイル読み込み機能の実装**
+   - yaml パッケージを使用してパース
+   - recipe 配列を順次処理するロジック
+```
+
+### 悪い計画例
+
+```markdown
+## やること
+- recipe 機能を追加する
+- テストを書く
+```
+
+（抽象的で実装イメージが湧かない）
+
+### 計画書作成完了時チェックリスト
+
+- [ ] 背景と課題が明確に記載されている
+- [ ] 解決策が具体的である
+- [ ] Phase 分けされている（最大 4-5 Phase）
+- [ ] ユーザーストーリーと受け入れ基準が記載されている
+- [ ] 技術的制約が考慮されている
+- [ ] システム影響範囲が特定されている
+- [ ] 実装順序が明確である
+- [ ] テスト戦略が記載されている
+- [ ] E2E テスト計画が作成されている
+- [ ] リスクと対策が記載されている
+
+---
+
+## 出力後の次ステップ
+
+計画ファイル作成後は、以下のワークフローに進みます（本プロンプトの対象外）：
+
+1. **GitHub Issue 起票**
+2. **ディレクトリリネーム**: `todo_plans/YYYYMMDD-temp-xxx/` → `todo_plans/${IssueNumber}/`
+3. **Issue 本文と index.md の同期**
+4. **plan ブランチ作成**
+5. **Agent Coding 開始**
+
+詳細は `artifact/prompts/development/plan-fix.prompt.md` を参照してください。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aramassa/ai-rules",
-  "version": "0.9.9",
+  "version": "0.9.11",
   "description": "This repository collects guidelines and instructions for developing AI agents. It contains documents covering communication rules, coding standards, testing strategies, and general operational practices.",
   "workspaces": [
     "packages/extract",

package/presets/codex-web/planning.yaml

@@ -0,0 +1,16 @@
+description: OpenAI CodexWeb 向け実装計画作成のための標準的なプロンプト構成です。
+
+config:
+  baseDir: ./
+
+recipe:
+  - title: "実装計画作成プロンプト（CodexWeb向け）"
+    out: "AGENTS.md"
+    type: "prompt"
+    filters:
+      category: "project-planning"
+      focus: "implementation-planning"
+      agent: "codex"
+    frontmatter:
+      description: "OpenAI CodexWeb 向け実装計画作成プロンプト。todo_plans/ 配下に詳細な計画ファイルを出力する。"
+      agent: "codex"