Skip to content

Add technology-agnostic blueprint generators for comprehensive project documentation #113

Merged
codemillmatt merged 8 commits into
github:mainfrom
zooav:ankur-technology-agnostic-prompt-for-instruction-generators
Jul 25, 2025
Merged

Add technology-agnostic blueprint generators for comprehensive project documentation #113
codemillmatt merged 8 commits into
github:mainfrom
zooav:ankur-technology-agnostic-prompt-for-instruction-generators

Conversation

@zooav

@zooav zooav commented Jul 19, 2025

Copy link
Copy Markdown
Contributor

Add technology-agnostic blueprint generators for comprehensive project documentation that helps GitHub Copilot to generate instructions that respect project-specific conventions.

  • Add architecture-blueprint-generator for documenting system design patterns
  • Add code-exemplars-blueprint-generator for identifying quality code standards
  • Add copilot-instructions-blueprint-generator for creating AI guidance files
  • Add folder-structure-blueprint-generator for documenting project organization
  • Add project-workflow-blueprint-generator for end-to-end process documentation
  • Add readme-blueprint-generator for comprehensive repository documentation
  • Add technology-stack-blueprint-generator for tech stack analysis

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Overview

This PR introduces a collection of 7 technology-agnostic blueprint generators that enable teams to automatically analyze and document their codebases comprehensively. These prompts help generate standardized documentation across different technology stacks while maintaining consistency and following best practices.

What's Included

  • Architecture Blueprint Generator - Analyzes and documents system architecture patterns, component relationships, and design decisions
  • Code Exemplars Blueprint Generator - Identifies high-quality code examples to establish coding standards and maintain consistency
  • Copilot Instructions Blueprint Generator - Creates comprehensive GitHub Copilot instructions based on actual codebase patterns
  • Folder Structure Blueprint Generator - Documents project organization patterns and file placement conventions
  • Project Workflow Blueprint Generator - Analyzes end-to-end application workflows and implementation patterns
  • README Blueprint Generator - Generates comprehensive README files by analyzing existing project documentation
  • Technology Stack Blueprint Generator - Documents technology choices, versions, and implementation patterns

Key Features

  • Technology Agnostic: Auto-detects and supports multiple tech stacks (.NET, Java, JavaScript, React, Python, etc.)
  • Configurable Variables: Each generator includes customizable parameters for different analysis depths and output formats
  • Pattern Recognition: Analyzes existing code to extract and document established patterns rather than imposing external conventions
  • Implementation Ready: Provides actionable templates and guidelines for maintaining consistency

Usage Context

These generators are designed to help development teams:

  • Onboard new developers faster with comprehensive documentation
  • Maintain architectural consistency across projects
  • Establish coding standards based on existing patterns
  • Generate GitHub Copilot instructions that respect project-specific conventions
  • Create standardized project documentation automatically

Benefits

  • Reduces documentation maintenance overhead
  • Ensures documentation stays synchronized with actual code patterns
  • Provides consistent structure across different project types
  • Enables better knowledge transfer and team collaboration

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes

Technical Implementation

  • Each generator uses variable substitution patterns (${VARIABLE}) for customization
  • Includes comprehensive front matter with detailed descriptions
  • Follows consistent naming conventions (*-blueprint-generator.prompt.md)

Integration

  • Designed to work with the awesome-copilot instruction system
  • Can be chained together for complete project documentation
  • Outputs reference each other for comprehensive coverage

Future Enhancements

  • Could be extended with additional technology stack support
  • Integration with CI/CD pipelines for automated documentation updates
  • Template library expansion based on community feedback

How to use Parameterized Prompts with Github Copilot Chat

Start your prompt by declaring the variables, then reference the template:

Example:

Set these variables:

  • PROJECT_TYPE = "Auto-detect"
  • DEPTH_LEVEL = "Standard"
  • INCLUDE_VERSIONS = true
  • INCLUDE_LICENSES = true
  • INCLUDE_DIAGRAMS = false
  • OUTPUT_FORMAT = "Markdown"
  • CATEGORIZATION = "Technology Type"

Then analyze the codebase using the template from the active document.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

…ion that helps GitHub Copilot to generate instructions that respect project-specific conventions

- Add architecture-blueprint-generator for documenting system design patterns
- Add code-exemplars-blueprint-generator for identifying quality code standards
- Add copilot-instructions-blueprint-generator for creating AI guidance files
- Add folder-structure-blueprint-generator for documenting project organization
- Add project-workflow-blueprint-generator for end-to-end process documentation
- Add readme-blueprint-generator for comprehensive repository documentation
- Add technology-stack-blueprint-generator for tech stack analysis
@codemillmatt

Copy link
Copy Markdown
Contributor

@zooav - thanks for the contributions!

Can you please run 'node update-readme.js' locally and commit the change? This way the new prompts show up in the overall readme.

Thanks!

@codemillmatt codemillmatt self-requested a review July 22, 2025 17:40
@zooav

zooav commented Jul 23, 2025

Copy link
Copy Markdown
Contributor Author

@zooav - thanks for the contributions!

Can you please run 'node update-readme.js' locally and commit the change? This way the new prompts show up in the overall readme.

Thanks!

@codemillmatt done, kindly review again, thanks.

@zooav

zooav commented Jul 23, 2025 via email

Copy link
Copy Markdown
Contributor Author

@codemillmatt

codemillmatt commented Jul 24, 2025

Copy link
Copy Markdown
Contributor

Hi @zooav - the readme.md should have been updated after running the update-readme.js. Include that in this PR too. If it wasn't updated, let me know that as well.

My bad - it's there.

Thanks for helping out here - we appreciate it!

@codemillmatt codemillmatt requested a review from Copilot July 24, 2025 22:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a comprehensive collection of 7 technology-agnostic blueprint generators that enable teams to automatically analyze and document their codebases. The generators help create standardized documentation across different technology stacks while maintaining consistency and following best practices.

  • Adds 7 blueprint generator prompts covering architecture, code exemplars, copilot instructions, folder structure, project workflow, README generation, and technology stack analysis
  • Updates README.md with entries for all new blueprint generators
  • Provides technology-agnostic solutions that auto-detect project types (.NET, Java, JavaScript, React, Python, etc.)

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
prompts/architecture-blueprint-generator.prompt.md Comprehensive architecture documentation generator with configurable analysis depth and diagram generation
prompts/code-exemplars-blueprint-generator.prompt.md Code quality exemplars identification tool with multi-language support and categorization options
prompts/copilot-instructions-blueprint-generator.prompt.md GitHub Copilot instruction file generator that analyzes existing codebase patterns
prompts/folder-structure-blueprint-generator.prompt.md Project organization documentation tool with visualization and naming convention analysis
prompts/project-workflow-analysis-blueprint-generator.prompt.md End-to-end workflow documentation generator covering entry points to data access
prompts/readme-blueprint-generator.prompt.md README.md generator that analyzes .github/copilot directory documentation
prompts/technology-stack-blueprint-generator.prompt.md Technology stack analysis and documentation tool with version detection
README.md Updated with 7 new prompt entries maintaining alphabetical order

Comment thread prompts/readme-blueprint-generator.prompt.md Outdated
Comment thread prompts/project-workflow-analysis-blueprint-generator.prompt.md Outdated
Comment thread prompts/folder-structure-blueprint-generator.prompt.md Outdated
Comment thread prompts/copilot-instructions-blueprint-generator.prompt.md
Comment thread prompts/code-exemplars-blueprint-generator.prompt.md

@codemillmatt codemillmatt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking as changes requested as per copilot.

zooav and others added 6 commits July 24, 2025 21:03
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
@zooav

zooav commented Jul 25, 2025

Copy link
Copy Markdown
Contributor Author

@codemillmatt Requested changes are done. please check one more time, thanks.

@codemillmatt codemillmatt merged commit d4a0af0 into github:main Jul 25, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants