{"meta":{"title":"README を作成する","intro":"プロジェクトの包括的な README ファイルを生成します。","product":"GitHub Copilot","breadcrumbs":[{"href":"/ja/copilot","title":"GitHub Copilot"},{"href":"/ja/copilot/tutorials","title":"チュートリアル"},{"href":"/ja/copilot/tutorials/customization-library","title":"カスタマイズ ライブラリ"},{"href":"/ja/copilot/tutorials/customization-library/prompt-files","title":"プロンプトファイル"},{"href":"/ja/copilot/tutorials/customization-library/prompt-files/create-readme","title":"README を作成する"}],"documentType":"article"},"body":"# README を作成する\n\nプロジェクトの包括的な README ファイルを生成します。\n\n> \\[!NOTE]\n>\n> * Copilot プロンプト ファイルは パブリック プレビュー 段階であり、変更される可能性があります。 プロンプト ファイルは、VS Code、Visual Studio、および JetBrains IDE でのみ使用できます。「[GitHub Copilotの応答をカスタマイズする方法](/ja/copilot/concepts/prompting/response-customization#about-prompt-files)」を参照してください。\n> * 特定の言語とシナリオ向けの、コミュニティに投稿されたプロンプト ファイルの例については、[Awesome GitHub Copilot Customizations](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md) リポジトリを参照してください。\n\nこのプロンプト ファイルは、project構造とコードベース全体を分析することで、プロフェッショナルで包括的な README ファイルを作成します。\n\n## README ジェネレーター プロンプト\n\n```text copy\n---\nagent: 'agent'\ndescription: 'Create a comprehensive README.md file for the project'\n---\n\n## Role\n\nYou're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files.\n\n## Task\n\n1. Review the entire project workspace and codebase\n2. Create a comprehensive README.md file with these essential sections:\n   - **What the project does**: Clear project title and description\n   - **Why the project is useful**: Key features and benefits\n   - **How users can get started**: Installation/setup instructions with usage examples\n   - **Where users can get help**: Support resources and documentation links\n   - **Who maintains and contributes**: Maintainer information and contribution guidelines\n\n## Guidelines\n\n### Content and Structure\n\n- Focus only on information necessary for developers to get started using and contributing to the project\n- Use clear, concise language and keep it scannable with good headings\n- Include relevant code examples and usage snippets\n- Add badges for build status, version, license if appropriate\n- Keep content under 500 KiB (GitHub truncates beyond this)\n\n### Technical Requirements\n\n- Use GitHub Flavored Markdown\n- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository\n- Ensure all links work when the repository is cloned\n- Use proper heading structure to enable GitHub's auto-generated table of contents\n\n### What NOT to include\n\nDon't include:\n- Detailed API documentation (link to separate docs instead)\n- Extensive troubleshooting guides (use wikis or separate documentation)\n- License text (reference separate LICENSE file)\n- Detailed contribution guidelines (reference separate CONTRIBUTING.md file)\n\nAnalyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.\n```\n\n## このプロンプト ファイルの使用方法\n\n1. 上記の内容を `create-readme.prompt.md` としてリポジトリの `.github/prompts` フォルダーに保存します。\n2. Visual Studio Code で Copilot チャット ビューを表示し、「`/create-readme`」と入力します。\n\n## 参考資料\n\n* Visual Studio Code ドキュメントの「[Visual Studio Code でプロンプト ファイルを使う](https://code.visualstudio.com/docs/copilot/customization/prompt-files)」- プロンプト ファイルの作成と使用の方法に関する情報\n* ```\n          [AUTOTITLE](/copilot/concepts/response-customization) - GitHub Copilot での応答カスタマイズの概要\n  ```\n* ```\n          [優れた GitHub Copilot カスタマイズ](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md) - コミュニティに投稿されたカスタム プロンプト ファイルや、特定の言語やシナリオ向けのその他のカスタマイズのリポジトリ\n  ```"}