@aramassa/ai-rules 0.1.6 → 0.2.1

package/artifact/prompts/ai-rules/for_prompts.prompt.md

@@ -0,0 +1,203 @@
+---
+type: prompt
+category: content-creation
+---
+
+## Prompts 作成ルール
+
+#### 基本ルール
+
+- ファイル名規則は `[用途名].prompt.md` または `[プロジェクト名]/[用途名].prompt.md`
+- プロンプトファイルにはfrontmatterで分類情報を付与する
+- 人間が使いやすく、AIが理解しやすい構造化されたプロンプトを作成する
+- **見出し階層は必ず `##` から開始する** - artifact/ 以下のMarkdownはrecipeファイルで統合されることを想定
+
+#### プロンプトファイルの構造
+
+#### 必須要素
+
+1. **Frontmatter** - プロンプトの分類・属性情報
+2. **プロンプト本体** - AIが実行すべき具体的なタスク
+3. **期待する出力形式** - 生成結果のフォーマットや構造
+
+#### Frontmatterの標準フィールド
+
+```yaml
+---
+type: prompt # プロンプトの種類
+category: [分類] # 用途別カテゴリ
+language: [対象言語] # 対象プログラミング言語（該当する場合）
+applyTo: "[対象パターン]" # 適用対象（該当する場合）
+human-instruction: |- # 人間向けの追加ガイダンス（オプション）
+  [使用上の注意点やコンテキスト]
+---
+```
+
+#### カテゴリ分類
+
+#### type 値の標準
+
+- `prompt` - 一般的なプロンプト
+
+#### category 値の例
+
+- `content-creation` - コンテンツ作成
+- `code-analysis` - コード分析
+- `documentation` - ドキュメント生成
+- `project-planning` - プロジェクト計画
+- `todo-planning` - TODO管理
+- `instruction-generation` - instruction生成
+- `structure-analysis` - 構造分析
+
+#### プロンプト作成ガイドライン
+
+#### 1. 明確性の原則
+
+- **具体的な指示**: 曖昧な表現を避け、実行すべきタスクを明確に記述
+- **期待する出力**: 生成結果のフォーマットや構造を具体的に示す
+- **制約条件**: 守るべきルールや制限を明記
+
+#### 2. 構造化の原則
+
+- **段階的な指示**: 複雑なタスクは段階的に分解
+- **見出し構造**: マークダウンの見出しでセクションを明確に分離
+- **見出し階層の統一**: メインタイトルは `##`、セクションは `###`、サブセクションは `####` で統一
+- **recipeファイル対応**: artifact/ 以下のファイルはrecipeで統合されるため、`#` レベルの見出しは使用禁止
+- **リスト活用**: 項目の列挙にはリストを使用
+
+#### 3. 再利用性の原則
+
+- **パラメータ化**: 変更が必要な部分は明確に示す
+- **テンプレート化**: 類似タスクで再利用できる構造
+- **カスタマイズ指針**: 具体的な用途に合わせた調整方法を記載
+
+#### 4. 品質保証の原則
+
+- **検証可能性**: 出力結果の品質を確認できる基準を提供
+- **エラー処理**: 想定される問題と対処法を記載
+- **改善指針**: プロンプトの効果を向上させる方法を提示
+
+#### プロンプト本体の構造
+
+#### 標準テンプレート
+
+**重要**: 以下のテンプレートでは `#` レベルから始まっていますが、artifact/ 以下の実際のファイルでは `##` レベルから開始してください。
+
+```markdown
+## [プロンプトのタイトル]
+
+### 目的
+
+[このプロンプトが解決する課題や目標を明記]
+
+### 前提条件
+
+[プロンプト実行前に必要な準備や条件]
+
+### 実行タスク
+
+[具体的な実行内容を段階的に記述]
+
+#### 手順1: [フェーズ名]
+
+[具体的な指示内容]
+
+#### 手順2: [フェーズ名]
+
+[具体的な指示内容]
+
+### 出力フォーマット
+
+[期待する出力の構造・形式]
+
+### 品質基準
+
+[出力結果の品質を判断する基準]
+
+### 使用例
+
+[具体的な使用場面や活用方法]
+
+### カスタマイズ指針
+
+[特定の用途に合わせた調整方法]
+```
+
+#### ディレクトリ構造の原則
+
+#### プロジェクト固有プロンプト
+
+```
+artifact/prompts/
+├── [プロジェクト名]/
+│   ├── [用途1].prompt.md
+│   ├── [用途2].prompt.md
+│   └── README.md           # プロジェクト固有プロンプトの説明
+└── [汎用プロンプト].prompt.md
+```
+
+#### 汎用プロンプト
+
+直接 `artifact/prompts/` ディレクトリに配置し、様々なプロジェクトで再利用可能にする
+
+#### 実践ガイドライン
+
+#### プロンプト作成時の確認事項
+
+- [ ] **目的の明確性**: 解決したい課題が具体的に説明されている
+- [ ] **指示の具体性**: AIが実行すべき内容が明確である
+- [ ] **出力の定義**: 期待する結果の形式が明記されている
+- [ ] **再利用性**: 他の用途でも活用できる構造になっている
+- [ ] **品質基準**: 結果の良し悪しを判断する基準がある
+- [ ] **見出し階層**: メインタイトルが `##` レベルから始まっている
+- [ ] **recipe対応**: `#` レベルの見出しを使用していない
+
+#### プロンプトの品質向上
+
+1. **テスト実行**: 実際にAIで実行して結果を確認
+2. **改善反復**: 期待する結果が得られるまで調整
+3. **ドキュメント化**: 効果的な使い方や注意点を記録
+4. **バージョン管理**: 変更履歴をGitで適切に管理
+
+#### 運用における注意事項
+
+- **一貫性の維持**: 同様の用途のプロンプトは統一された構造を使用
+- **メンテナンス**: 技術の進歩に合わせてプロンプトを更新
+- **共有促進**: チーム内でのプロンプト活用を促進
+- **フィードバック収集**: 使用者からの改善提案を積極的に収集
+
+#### 関連ドキュメント
+
+- [Instructions作成ルール](../../instructions/) - AI向けinstruction管理
+- [TODO Plans作成ルール](../development/todo_plans.prompt.md) - 計画管理プロンプト
+- [Recipe Files](../../../presets/) - プロンプト組み合わせ設定
+
+#### ファイル名規則の例
+
+```
+artifact/prompts/
+├── ai-rules/
+│   ├── for_prompts.prompt.md         # 本ファイル
+│   ├── project_analysis.prompt.md    # プロジェクト分析用
+│   └── migration_guide.prompt.md     # 移行ガイド生成用
+├── documentation/
+│   ├── api_docs.prompt.md            # API文書生成
+│   └── readme_generator.prompt.md    # README生成
+├── development/
+│   └── todo_plans.prompt.md          # TODO計画管理
+├── code_analysis.prompt.md           # 汎用コード分析
+```
+
+#### メタルール
+
+#### プロンプトの進化
+
+- **継続的改善**: 使用結果を基にプロンプトを継続的に改善
+- **ベストプラクティス抽出**: 効果的なパターンを標準化
+- **知識の蓄積**: 成功事例と失敗事例を記録・共有
+
+#### 品質保証
+
+- **レビュープロセス**: 新規プロンプトは使用前にレビュー
+- **効果測定**: プロンプトの効果を定量的・定性的に評価
+- **標準化推進**: 組織全体でのプロンプト品質向上

package/artifact/prompts/{todo_plans.prompt.md → development/todo_plans.prompt.md}

@@ -4,33 +4,33 @@ category: todo-planning
 focus: workflow-management
 ---
 
-# TODO Plans 作成ルール
+## TODO Plans 作成ルール
 
-## 基本ルール
+### 基本ルール
 
 - 今後の計画を立てる際は、必ず `todo_plans/` に記載する
 - ファイル名規則は、`YYYYMMDD_[タイトル].md`
 - 計画が不要になった場合は削除する。Git の履歴で過去の計画は追跡できるため、アーカイブせずにリポジトリをすっきり保つ
 
-## ワークフロー管理
+### ワークフロー管理
 
-### todo_plans の役割
+#### todo_plans の役割
 
-#### todo_plans段階
+##### todo_plans段階
 
 - **目的**: 将来の計画とアイデアの整理
 - **期間**: プロジェクトのアイデア段階
 - **成果物**: 計画の概要と方向性
 - **品質基準**: 実現したいことが明確に記述されている
 
-## 実践ガイドライン
+### 実践ガイドライン
 
 - 将来実装したい機能やアイデアは、必ず todo_plans/ に記載する
 - 計画の内容は、実現したいことと大まかな方向性を記述する
 - 詳細な実装方法は不要。コンセプトレベルで十分
 - 計画が変更されたり不要になった場合は、ファイルを削除してリポジトリを整理する
 
-## ファイル名規則の例
+### ファイル名規則の例
 
 ```
 todo_plans/
@@ -39,7 +39,7 @@ todo_plans/
 └── 20250911_新機能企画書.md
 ```
 
-## 注意事項
+### 注意事項
 
 - todo_plans は「将来やりたいこと」「検討したいアイデア」の整理段階
 - 具体的な実装計画ではなく、方向性やコンセプトを記録する

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aramassa/ai-rules",
-  "version": "0.1.6",
+  "version": "0.2.1",
   "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/prompts/prompt-creation.yaml

@@ -0,0 +1,10 @@
+config:
+  baseDir: .github/prompts
+recipe:
+  - title: "Prompts 作成ルール"
+    out: "create_prompts.prompt.md"
+    type: "prompt"
+    category: "content-creation"
+    frontmatter:
+      description: "AI向けプロンプト作成のための包括的なルールとガイドライン。プロンプト工学のベストプラクティスを体系化。"
+      applyTo: "artifact/prompts/**/*.prompt.md"

package/presets/prompts/todo-planning.yaml

@@ -1,6 +1,8 @@
+config:
+  baseDir: .github/prompts
 recipe:
   - title: "TODO Plans 作成ルール"
-    out: "./.github/prompts/todo_plans.prompt.md"
+    out: "todo_plans.prompt.md"
     type: "prompt"
     category: "todo-planning"
     focus: "workflow-management"