プロジェクトワークフロー文書化ジェネレータ

設定変数

${PROJECT_TYPE="Auto-detect|.NET|Java|Spring|Node.js|Python|React|Angular|Microservices|Other"}
<!-- 主要テクノロジースタック -->

${ENTRY_POINT="API|GraphQL|Frontend|CLI|Message Consumer|Scheduled Job|Custom"}
<!-- フローの開始ポイント -->

${PERSISTENCE_TYPE="Auto-detect|SQL Database|NoSQL Database|File System|External API|Message Queue|Cache|None"}
<!-- データストレージ型 -->

${ARCHITECTURE_PATTERN="Auto-detect|Layered|Clean|CQRS|Microservices|MVC|MVVM|Serverless|Event-Driven|Other"}
<!-- 主要アーキテクチャパターン -->

${WORKFLOW_COUNT=1-5}
<!-- 文書化するワークフローの数 -->

${DETAIL_LEVEL="Standard|Implementation-Ready"}
<!-- 含める実装詳細のレベル -->

${INCLUDE_SEQUENCE_DIAGRAM=true|false}
<!-- シーケンス図を生成 -->

${INCLUDE_TEST_PATTERNS=true|false}
<!-- テストアプローチを含める -->

生成されるプロンプト

"コードベースを分析し、${WORKFLOW_COUNT}個の代表的なエンドツーエンドワークフローを文書化します。
これらは類似機能の実装テンプレートとして機能します。以下のアプローチを使用してください:

初期検出フェーズ

${PROJECT_TYPE == "Auto-detect" ? 
  "コードベース構造を調べてテクノロジーを特定することで開始します:
   - .NETソリューション/プロジェクト、Spring設定、Node.js/Expressファイルなどを確認
   - 使用中の主要プログラミング言語とフレームワークを特定
   - フォルダ構造と主要コンポーネントに基づいてアーキテクチャパターンを決定" 
  : "${PROJECT_TYPE}パターンと規約に焦点を当てます"}

${ENTRY_POINT == "Auto-detect" ? 
  "以下を検索して典型的なエントリーポイントを特定します:
   - APIコントローラーまたはルート定義
   - GraphQLリゾルバー
   - ネットワークリクエストを開始するUIコンポーネント
   - メッセージハンドラーまたはイベントサブスクライバー
   - スケジュール済みジョブ定義" 
  : "${ENTRY_POINT}エントリーポイントに焦点を当てます"}

${PERSISTENCE_TYPE == "Auto-detect" ? 
  "以下を調べることで永続化メカニズムを決定します:
   - データベースコンテキスト/接続設定
   - リポジトリ実装
   - ORM マッピング
   - 外部API クライアント
   - ファイルシステムインタラクション" 
  : "${PERSISTENCE_TYPE}インタラクションに焦点を当てます"}

ワークフロー文書化手順

システム内の最も代表的な${WORKFLOW_COUNT}個のワークフローそれぞれについて:

1. ワークフロー概要

• ワークフローの名前と簡単な説明を提供
• 提供するビジネス目的を説明
• トリガーアクションまたはイベントを特定
• 完全なワークフローに関連する全ファイル/クラスをリスト化

2. エントリーポイント実装

APIエントリーポイント:

${ENTRY_POINT == "API" || ENTRY_POINT == "Auto-detect" ? 
  "- リクエストを受け取るAPIコントローラークラスとメソッドを文書化
   - 属性/アノテーションを含む完全なメソッド署名を表示
   - 完全なリクエストDTO/モデルクラス定義を含める
   - 検証属性とカスタムバリデータを文書化
   - 認証/認可属性とチェックを表示" : ""}

GraphQLエントリーポイント:

${ENTRY_POINT == "GraphQL" || ENTRY_POINT == "Auto-detect" ? 
  "- GraphQLリゾルバークラスとメソッドを文書化
   - クエリ/ミューテーション用の完全なスキーマ定義を表示
   - 入力型定義を含める
   - パラメータハンドリングを含むリゾルバーメソッド実装を表示" : ""}

フロントエンドエントリーポイント:

${ENTRY_POINT == "Frontend" || ENTRY_POINT == "Auto-detect" ? 
  "- APIコールを開始するコンポーネントを文書化
   - リクエストをトリガーするイベントハンドラーを表示
   - APIクライアントサービスメソッドを含める
   - リクエストに関連するステート管理コードを表示" : ""}

メッセージコンシューマーエントリーポイント:

${ENTRY_POINT == "Message Consumer" || ENTRY_POINT == "Auto-detect" ? 
  "- メッセージハンドラークラスとメソッドを文書化
   - メッセージサブスクリプション設定を表示
   - 完全なメッセージモデル定義を含める
   - デシリアライゼーションと検証ロジックを表示" : ""}

3. サービスレイヤー実装

• 依存関係を含む各サービスクラスを文書化
• パラメータと戻り値の型を含む完全なメソッド署名を表示
• 主要ビジネスロジックを含む実装を表示
• 該当する場合はインターフェース定義を文書化
• 依存注入の登録パターンを表示

CQRSパターン:

${ARCHITECTURE_PATTERN == "CQRS" || ARCHITECTURE_PATTERN == "Auto-detect" ? 
  "- 完全なコマンド/クエリハンドラー実装を含める" : ""}

クリーンアーキテクチャパターン:

${ARCHITECTURE_PATTERN == "Clean" || ARCHITECTURE_PATTERN == "Auto-detect" ? 
  "- ユースケース/インタラクター実装を表示" : ""}

4. データマッピングパターン

• DTO からドメインモデルへのマッピングコードを文書化
• オブジェクトマッパー設定または手動マッピングメソッドを表示
• マッピング時の検証ロジックを含める
• マッピング中に作成されるドメインイベントを文書化

5. データアクセス実装

• リポジトリインターフェースと実装を文書化
• パラメータと戻り値の型を含む完全なメソッド署名を表示
• 実際のクエリ実装を含める
• 全プロパティを含むエンティティ/モデルクラス定義を文書化
• トランザクション処理パターンを表示

SQLデータベースパターン:

${PERSISTENCE_TYPE == "SQL Database" || PERSISTENCE_TYPE == "Auto-detect" ? 
  "- ORM設定、アノテーション、またはFluent API使用法を含める
   - 実際のSQLクエリまたはORM ステートメントを表示" : ""}

NoSQLデータベースパターン:

${PERSISTENCE_TYPE == "NoSQL Database" || PERSISTENCE_TYPE == "Auto-detect" ? 
  "- ドキュメント構造定義を表示
   - ドキュメントクエリ/更新操作を含める" : ""}

6. レスポンス構築

• レスポンスDTO/モデルクラス定義を文書化
• ドメイン/エンティティモデルからレスポンスモデルへのマッピングを表示
• ステータスコード選択ロジックを含める
• エラーレスポンス構造と生成を文書化

7. エラーハンドリングパターン

• ワークフロー内で使用される例外型を文書化
• 各レイヤーのtry/catchパターンを表示
• グローバル例外ハンドラー設定を含める
• エラーログ実装を文書化
• リトライポリシーまたはサーキットブレーカーパターンを表示
• 失敗シナリオの補償アクションを含める

8. 非同期処理パターン

• バックグラウンドジョブスケジューリングコードを文書化
• イベント公開実装を表示
• メッセージキュー送信パターンを含める
• コールバックまたはWebhook実装を文書化
• 非同期操作の追跡と監視方法を表示

テストアプローチ(オプション):

${INCLUDE_TEST_PATTERNS ? 
  "9. **テストアプローチ**
     - 各レイヤーの単体テスト実装を文書化
     - モッキングパターンとテストフィクスチャセットアップを表示
     - 統合テスト実装を含める
     - テストデータ生成アプローチを文書化
     - API/コントローラーテスト実装を表示" : ""}

シーケンス図(オプション):

${INCLUDE_SEQUENCE_DIAGRAM ? 
  "10. **シーケンス図**
      - すべてのコンポーネントを示す詳細なシーケンス図を生成
      - パラメータ型を含むメソッドコールを含める
      - コンポーネント間の戻り値を表示
      - 条件付きフローとエラーパスを文書化" : ""}

11. 命名規約

以下の一貫したパターンを文書化:

• コントローラー命名(例: EntityNameController)
• サービス命名(例: EntityNameService)
• リポジトリ命名(例: IEntityNameRepository)
• DTO命名(例: EntityNameRequest, EntityNameResponse)
• CRUD操作のメソッド命名パターン
• 変数命名規約
• ファイル組織パターン

12. 実装テンプレート

以下の再利用可能なコードテンプレートを提供:

• パターンに従う新しいAPIエンドポイントの作成
• 新しいサービスメソッドの実装
• 新しいリポジトリメソッドの追加
• 新しいドメインモデルクラスの作成
• 適切なエラーハンドリングの実装

テクノロジー固有の実装パターン

.NET実装パターン(検出された場合):

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "Auto-detect" ? 
  "- 属性、フィルター、依存注入を含む完全なコントローラークラス
   - Startup.csまたはProgram.csでのサービス登録
   - Entity Framework DbContext設定
   - Entity Framework Coreまたは Dapperを使用したリポジトリ実装
   - AutoMapper プロファイル設定
   - クロスカッティングコンサーン用ミドルウェア実装
   - 拡張メソッドパターン
   - 設定のOptions パターン実装
   - ILogger を使用したログ実装
   - 認証/認可フィルターまたはポリシー実装" : ""}

Spring実装パターン(検出された場合):

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Spring" || PROJECT_TYPE == "Auto-detect" ? 
  "- アノテーションと依存注入を含む完全なコントローラークラス
   - トランザクション境界を持つサービス実装
   - リポジトリインターフェースと実装
   - リレーションシップを持つJPA エンティティ定義
   - DTO クラス実装
   - Bean設定とコンポーネントスキャン
   - 例外ハンドラー実装
   - カスタムバリデータ実装" : ""}

React実装パターン(検出された場合):

${PROJECT_TYPE == "React" || PROJECT_TYPE == "Auto-detect" ? 
  "- プロップスとステートを含むコンポーネント構造
   - フック実装パターン(useState、useEffect、カスタムフック)
   - API サービス実装
   - ステート管理パターン(Context、Redux)
   - フォームハンドリング実装
   - ルート設定" : ""}

実装ガイドライン

文書化されたワークフローに基づいて、新機能の実装に関する具体的なガイダンスを提供します:

1. ステップバイステップの実装プロセス

• 類似機能を追加するときにどこから始めるか
• 実装の順序(例: モデル → リポジトリ → サービス → コントローラー)
• 既存のクロスカッティングコンサーンとの統合方法

2. 避けるべき一般的な落とし穴

• 現在の実装でエラーが起きやすい領域を特定
• パフォーマンスに関する考慮事項を記載
• 遭遇した一般的なバグまたは問題をリスト化

3. 拡張メカニズム

• 既存の拡張ポイントへの接続方法を文書化
• 既存コードを修正せずに新しい動作を追加する方法を表示
• 設定駆動型の機能パターンを説明

結論: コードベースとの一貫性を保ちながら新機能を実装する場合に従うべき最も重要なパターンの 概要で締めくくります。