Project-Workflow-Analysis-Blueprint-Generator
Project-Workflow-Analysis-Blueprint-Generator是一款code方向的AI技能,核心价值是Comprehensive technology-agnostic prompt generator for documenting end-to-end application workflows,可用于解决开发者在code领域的实际问题,帮助用户提升效率、自动化重复任务或优化工作流。
Comprehensive technology-agnostic prompt generator for documenting end-to-end application workflows. Automatically detects project architecture patterns, technology stacks, and data flow patterns to g
mkdir -p ./skills/project-workflow-analysis-blueprint-generator && curl -sfL https://raw.githubusercontent.com/github/awesome-copilot/main/skills/project-workflow-analysis-blueprint-generator/SKILL.md -o ./skills/project-workflow-analysis-blueprint-generator/SKILL.md Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).
Skill Content
# Project Workflow Documentation Generator
Configuration Variables
${PROJECT_TYPE="Auto-detect|.NET|Java|Spring|Node.js|Python|React|Angular|Microservices|Other"}
<!-- Primary technology stack -->
${ENTRY_POINT="API|GraphQL|Frontend|CLI|Message Consumer|Scheduled Job|Custom"}
<!-- Starting point for the flow -->
${PERSISTENCE_TYPE="Auto-detect|SQL Database|NoSQL Database|File System|External API|Message Queue|Cache|None"}
<!-- Data storage type -->
${ARCHITECTURE_PATTERN="Auto-detect|Layered|Clean|CQRS|Microservices|MVC|MVVM|Serverless|Event-Driven|Other"}
<!-- Primary architecture pattern -->
${WORKFLOW_COUNT=1-5}
<!-- Number of workflows to document -->
${DETAIL_LEVEL="Standard|Implementation-Ready"}
<!-- Level of implementation detail to include -->
${INCLUDE_SEQUENCE_DIAGRAM=true|false}
<!-- Generate sequence diagram -->
${INCLUDE_TEST_PATTERNS=true|false}
<!-- Include testing approach -->Generated Prompt
"Analyze the codebase and document ${WORKFLOW_COUNT} representative end-to-end workflows
that can serve as implementation templates for similar features. Use the following approach:Initial Detection Phase
${PROJECT_TYPE == "Auto-detect" ?
"Begin by examining the codebase structure to identify technologies:
- Check for .NET solutions/projects, Spring configurations, Node.js/Express files, etc.
- Identify the primary programming language(s) and frameworks in use
- Determine the architectural patterns based on folder structure and key components"
: "Focus on ${PROJECT_TYPE} patterns and conventions"}${ENTRY_POINT == "Auto-detect" ?
"Identify typical entry points by looking for:
- API controllers or route definitions
- GraphQL resolvers
- UI components that initiate network requests
- Message handlers or event subscribers
- Scheduled job definitions"
: "Focus on ${ENTRY_POINT} entry points"}${PERSISTENCE_TYPE == "Auto-detect" ?
"Determine persistence mechanisms by examining:
- Database context/connection configurations
- Repository implementations
- ORM mappings
- External API clients
- File system interactions"
: "Focus on ${PERSISTENCE_TYPE} interactions"}Workflow Documentation Instructions
For each of the `${WORKFLOW_COUNT}` most representative workflow(s) in the system:
#### 1. Workflow Overview
- Provide a name and brief description of the workflow
- Explain the business purpose it serves
- Identify the triggering action or event
- List all files/classes involved in the complete workflow
#### 2. Entry Point Implementation
**API Entry Points:**
${ENTRY_POINT == "API" || ENTRY_POINT == "Auto-detect" ?
"- Document the API controller class and method that receives the request
- Show the complete method signature including attributes/annotations
- Include the full request DTO/model class definition
- Document validation attributes and custom validators
- Show authentication/authorization attributes and checks" : ""}**GraphQL Entry Points:**
${ENTRY_POINT == "GraphQL" || ENTRY_POINT == "Auto-detect" ?
"- Document the GraphQL resolver class and method
- Show the complete schema definition for the query/mutation
- Include input type definitions
- Show resolver method implementation with parameter handling" : ""}**Frontend Entry Points:**
${ENTRY_POINT == "Frontend" || ENTRY_POINT == "Auto-detect" ?
"- Document the component that initiates the API call
- Show the event handler that triggers the request
- Include the API client service method
- Show state management code related to the request" : ""}**Message Consumer Entry Points:**
${ENTRY_POINT == "Message Consumer" || ENTRY_POINT == "Auto-detect" ?
"- Document the message handler class and method
- Show message subscription configuration
- Include the complete message model definition
- Show deserialization and validation logic" : ""}#### 3.
🎯 Best For
- Technical writers
- API documentation teams
- Claude users
- GitHub Copilot users
- Software engineers
💡 Use Cases
- Generating JSDoc/TSDoc comments
- Writing README files for new projects
- Code quality improvement
- Best practice enforcement
📖 How to Use This Skill
- 1
Install the Skill
Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.
- 2
Load into Your AI Assistant
Open Claude or GitHub Copilot and reference the skill. Paste the SKILL.md content or use the system prompt tab.
- 3
Apply Project-Workflow-Analysis-Blueprint-Generator to Your Work
Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.
- 4
Review and Refine
Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.
❓ Frequently Asked Questions
Does it follow my documentation style?
Most documentation skills respect existing style. Provide a style guide or example in your prompt.
Is Project-Workflow-Analysis-Blueprint-Generator compatible with Cursor and VS Code?
Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.
Do I need specific dependencies for Project-Workflow-Analysis-Blueprint-Generator?
Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.
How do I install Project-Workflow-Analysis-Blueprint-Generator?
Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/project-workflow-analysis-blueprint-generator/SKILL.md, ready to use.
Can I customize this skill for my team?
Absolutely. Edit the SKILL.md file to add team-specific instructions, examples, or workflows.
⚠️ Common Mistakes to Avoid
Auto-generating without reviewing
AI documentation can contain inaccuracies. Always verify technical accuracy.
Skipping validation
Always test AI-generated code changes, even for simple refactors.
Missing dependency updates
Check if the skill requires updated dependencies or new packages.