readme-blueprint-generator
Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.
Resumen
README Generator Prompt
Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:
- Scan all the files in the .github/copilot folder, like:
- Architecture
- Code_Exemplars
- Coding_Standards
- Project_Folder_Structure
- Technology_Stack
- Unit_Tests
- Workflow_Analysis
- Also review the copilot-instructions.md file in the .github folder
- Create a README.md with the following sections:
Project Name and Description
- Extract the project name and primary purpose from the documentation
- Include a concise description of what the project does
Technology Stack
- List the primary technologies, languages, and frameworks used
- Include version information when available
- Source this information primarily from the Technology_Stack file
Project Architecture
- Provide a high-level overview of the architecture
- Consider including a simple diagram if described in the documentation
- Source from the Architecture file
Getting Started
- Include installation instructions based on the technology stack
- Add setup and configuration steps
- Include any prerequisites
Project Structure
- Brief overview of the folder organization
- Source from Project_Folder_Structure file
Key Features
- List main functionality and features of the project
- Extract from various documentation files
Development Workflow
- Summarize the development process
- Include information about branching strategy if available
- Source from Workflow_Analysis file
Coding Standards
- Summarize key coding standards and conventions
- Source from the Coding_Standards file
Testing
- Explain testing approach and tools
- Source from Unit_Tests file
Contributing
- Guidelines for contributing to the project
- Reference any code exemplars for guidance
- Source from Code_Exemplars and copilot-instructions
License
- Include license information if available
Format the README with proper Markdown, including:
- Clear headings and subheadings
- Code blocks where appropriate
- Lists for better readability
- Links to other documentation files
- Badges for build status, version, etc. if information is available
Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.
Archivos 1 archivo
Instálala a mano
Deska ejecuta esto por ti, para cada agente que elijas. Para ejecutarlo tú en una terminal:
npx skills add github/awesome-copilot --skill readme-blueprint-generatorMás de github
- git-commitgithubExecute git commit with conventional commit message analysis, intelligent staging, and message generation. Use when user asks to commit changes, create a git commit, or mentions "/commit". Supports: (1) Auto-detecting type and scope from changes, (2) Generating conventional commit messages from diff, (3) Interactive commit with optional type/scope/description overrides, (4) Intelligent file staging for logical grouping46 k instalaciones en skills.sh0
- excalidraw-diagram-generatorgithubGenerate Excalidraw diagrams from natural language descriptions. Use when asked to "create a diagram", "make a flowchart", "visualize a process", "draw a system architecture", "create a mind map", or "generate an Excalidraw file". Supports flowcharts, relationship diagrams, mind maps, and system architecture diagrams. Outputs .excalidraw JSON files that can be opened directly in Excalidraw.30.8 k instalaciones en skills.sh0
- documentation-writergithubDiátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.27.1 k instalaciones en skills.sh0
- prdgithubGenerate high-quality Product Requirements Documents (PRDs) for software systems and AI-powered features. Includes executive summaries, user stories, technical specifications, and risk analysis.23.6 k instalaciones en skills.sh0
- refactorgithubSurgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.22 k instalaciones en skills.sh0