readme-blueprint-generator

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. Use when this capability is needed.
metadata	{"author":"AICyberGuardian"}

README Blueprint Generator

Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.

Key Features

• Scans .github/copilot/ directory files for project metadata
• Reviews copilot-instructions.md for development guidelines
• Extracts technology stack information
• Documents project architecture
• Includes getting started guides
• Lists folder structure and project organization
• Summarizes development workflow and coding standards
• Documents testing approaches
• Creates contribution guidelines

When to Use

• Creating initial README for a project
• Updating README to reflect architectural changes
• Standardizing documentation structure across projects
• Adding comprehensive onboarding information
• Generating developer-focused documentation

Generated Sections

• Project Name and Description
• Technology Stack with versions
• Project Architecture overview
• Getting Started and Installation
• Project Structure explanation
• Key Features and Functionality
• Development Workflow
• Coding Standards and Conventions
• Testing Approaches
• Contributing Guidelines
• Links to Additional Documentation

---

Source: AICyberGuardian/storycraftr-next — distributed by TomeVault.