williamlimasilva/readme-blueprint-generator
skills/readme-blueprint-generator/SKILL.md
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.
development
Updated May 6, 2026
$ install --global
skillsauthnpx skillsauth add williamlimasilva/.copilot readme-blueprint-generatorInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Error
VirusTotalMulti-engine malware detection
70%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Mar 18, 2026, 6:32 PM106.5s1 file scanned
SKILL.md
- name:
- readme-blueprint-generator
- description:
- 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.
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.
Related Skills
williamlimasilva/from-the-other-side-wiggins
tools
VerifiedTrustedCommunity
Narrative and synthesis profile for Wiggins: framing, explanation, and audience-aware communication patterns for Ember sessions.
SKILL.mdUpdated May 29, 2026
williamlimasilva/from-the-other-side-quinn
tools
VerifiedTrustedCommunity
Collaboration profile for Quinn: curious, energetic, and implementation-focused partnership patterns for Ember sessions with Alison.
SKILL.mdUpdated May 29, 2026
williamlimasilva/from-the-other-side-anitta
development
VerifiedTrustedCommunity
Rigorous challenge profile for Anitta: assumption checks, evidence calibration, and defensible reasoning patterns for Ember collaboration.
SKILL.mdUpdated May 29, 2026
williamlimasilva/conventional-branch
testing
VerifiedTrustedCommunity
Create Git branches following the Conventional Branch specification (feature/, bugfix/, hotfix/, release/, chore/). Use when creating a new branch, naming a branch, or checking whether a branch name complies with the spec.
SKILL.mdUpdated May 29, 2026