readme-blueprint-generator

README 生成プロンプト

.github/copilot ディレクトリ内のドキュメントファイルと copilot-instructions.md ファイルを分析して、このリポジトリの包括的な README.md を生成します。次の手順に従ってください:

1. .github/copilot フォルダ内のすべてのファイルをスキャンします。たとえば:

   • Architecture
   • Code_Exemplars
   • Coding_Standards
   • Project_Folder_Structure
   • Technology_Stack
   • Unit_Tests
   • Workflow_Analysis

2. また、.github フォルダ内の copilot-instructions.md ファイルも確認します

3. 次のセクションを含む README.md を作成します:

プロジェクト名と説明

• ドキュメントからプロジェクト名と主な目的を抽出します
• プロジェクトが何を行うのかを簡潔に説明します

テクノロジースタック

• 使用されている主要なテクノロジー、言語、フレームワークを列挙します
• 利用可能な場合はバージョン情報を含めます
• この情報は主に Technology_Stack ファイルから取得します

プロジェクトアーキテクチャ

• アーキテクチャの概要を提供します
• ドキュメントで説明されている場合は、簡単な図を含めることを検討します
• Architecture ファイルから取得します

はじめに

• テクノロジースタックに基づいたインストール手順を含めます
• セットアップと構成の手順を追加します
• 前提条件があれば記載します

プロジェクト構造

• フォルダ構成の概要を説明します
• Project_Folder_Structure ファイルから取得します

主な機能

• プロジェクトの主な機能と特徴を列挙します
• 各種ドキュメントファイルから抽出します

開発ワークフロー

• 開発プロセスを要約します
• 利用可能な場合はブランチ戦略に関する情報を含めます
• Workflow_Analysis ファイルから取得します

コーディング標準

• 主要なコーディング標準と規約を要約します
• Coding_Standards ファイルから取得します

テスト

• テストのアプローチとツールを説明します
• Unit_Tests ファイルから取得します

コントリビューション

• プロジェクトへのコントリビューションに関するガイドラインを記載します
• 参考としてコード例を参照します
• Code_Exemplars および copilot-instructions から取得します

ライセンス

• 利用可能な場合はライセンス情報を含めます

README は適切な Markdown でフォーマットし、次のことを含めます:

• 明確な見出しと小見出し
• 適切な箇所でのコードブロック
• 可読性を高めるためのリスト
• 他のドキュメントファイルへのリンク
• 情報が利用可能な場合は、ビルドステータスやバージョンなどのバッジ

README は簡潔かつ有益なものにし、新規の開発者やユーザーがプロジェクトについて知っておく必要があることに焦点を当ててください。