diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json index 4296fd1..897b5ac 100644 --- a/.claude-plugin/marketplace.json +++ b/.claude-plugin/marketplace.json @@ -18,6 +18,11 @@ "name": "presentation-pdf-export", "source": "./presentation-pdf-export", "description": "PDF document generator for a HTML-based presentation generated by the presentation-manager skill." + }, + { + "name": "java-architecture-analyst", + "source": "./java-architecture-analyst", + "description": "Java Architecture Analyst that delivers targeted architecture reports." } ] } diff --git a/README.md b/README.md index d4e2e3f..550e2db 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,21 @@ A specialized plugin for generating professional PDF documents from HTML-based p [View plugin documentation →](./presentation-pdf-export/README.md) +### java-architecture-analyst + +An expert-level Java architecture analysis agent that produces structured, evidence-based architecture reports for Java/Spring Boot applications. Supports analysis across 18 specialized architectural layers. + +**Key Features:** +- **18 Architectural Layers** - Comprehensive analysis from project overview to deployment operations +- **Evidence-Based Reports** - Detailed documentation with code references and findings +- **Multi-Layer Analysis** - Analyze multiple layers in a single command +- **Specialized Templates** - Each layer focuses on specific architectural concerns + +**Available Agent:** +- **`java-architecture-analyst`** - AI-powered architecture analysis agent with configurable layer selection + +[View plugin documentation →](./java-architecture-analyst/README.md) + ## Installation ### Prerequisites @@ -171,21 +186,51 @@ Use the `/plugin` menu to browse, enable, disable, or uninstall plugins interact │ │ └── plugin.json # Plugin metadata │ └── commands/ │ └── cc.md # Conventional Commit command +├── java-architecture-analyst/ # java-architecture-analyst plugin +│ ├── README.md # Plugin documentation +│ ├── .claude-plugin/ +│ │ └── plugin.json # Plugin metadata +│ └── agents/ +│ ├── java-architecture-analyst.md # Architecture analysis agent +│ ├── layers/ # 18 analysis layer templates +│ │ ├── project-overview.md +│ │ ├── technology-stack.md +│ │ ├── application-architecture.md +│ │ ├── architectural-patterns.md +│ │ ├── business-logic-architecture.md +│ │ ├── data-architecture.md +│ │ ├── requests-flow.md +│ │ ├── security-architecture.md +│ │ ├── configuration-management.md +│ │ ├── cross-cutting-concerns.md +│ │ ├── performance-scalability.md +│ │ ├── testing.md +│ │ ├── deployment-operations.md +│ │ ├── cost-resource-optimization.md +│ │ ├── key-design-decisions.md +│ │ ├── recommendations.md +│ │ ├── conclusions.md +│ │ └── appendices.md +│ ├── output-formats/ +│ │ └── layer-medium-report.md +│ └── patterns/ +│ └── active-developer.md ├── presentation-manager/ # presentation-manager plugin │ ├── README.md # Plugin documentation │ ├── .claude-plugin/ │ │ └── plugin.json # Plugin metadata │ ├── skills/ -│ │ └── SKILL.md # Presentation Manager skill -│ ├── commands/ # Command definitions -│ │ ├── new-slide.md -│ │ ├── add-topic.md -│ │ ├── list-slides.md -│ │ ├── preview.md -│ │ ├── validate-presentation.md -│ │ └── reorder-slides.md -│ └── assets/ -│ └── shared-styles.css # Shared brand styles +│ │ ├── SKILL.md # Presentation Manager skill +│ │ ├── package.json # npm dependencies +│ │ └── templates/ +│ │ └── shared-styles.css # Shared brand styles +│ └── commands/ # Command definitions +│ ├── new-slide.md +│ ├── add-topic.md +│ ├── list-slides.md +│ ├── preview.md +│ ├── validate-presentation.md +│ └── reorder-slides.md └── presentation-pdf-export/ # presentation-pdf-export plugin ├── README.md # Plugin documentation ├── .claude-plugin/ @@ -232,7 +277,13 @@ For issues, questions, or feature requests, please open an issue in this reposit ## Version History -### 0.0.3 (Current) +### 0.0.4 (Current) +- Added `java-architecture-analyst` plugin for expert-level Java/Spring Boot architecture analysis +- Includes `java-architecture-analyst` agent with 18 specialized architectural layers +- Evidence-based reporting with code references and multi-layer analysis support +- Specialized templates for each architectural layer from project overview to deployment operations + +### 0.0.3 - Added `presentation-pdf-export` plugin for generating professional PDFs from HTML presentations - Includes `presentation-pdf-export` skill for automated PDF generation with Puppeteer - Automatic dependency management and setup diff --git a/java-architecture-analyst/.claude-plugin/plugin.json b/java-architecture-analyst/.claude-plugin/plugin.json new file mode 100644 index 0000000..4e7239b --- /dev/null +++ b/java-architecture-analyst/.claude-plugin/plugin.json @@ -0,0 +1,34 @@ +{ + "name": "java-architecture-analyst", + "description": "Java Architecture Analyst that delivers targeted architecture reports", + "version": "0.0.1", + "author": { + "name": "Stefania Pozzi", + "email": "s.pozzi@sourcelabs.nl" + }, + "keywords": [ + "java", + "architecture", + "analysis", + "code-review", + "project-overview", + "application-architecture", + "architectural-patterns", + "business-logic-architecture", + "data-architecture", + "security-architecture", + "performance-scalability", + "testing", + "deployment-operations", + "configuration-management", + "cross-cutting-concerns", + "requests-flow", + "technology-stack", + "key-design-decisions", + "cost-resource-optimization", + "recommendations", + "conclusions", + "appendices" + ], + "agents": ["./agents/java-architecture-analyst.md"] +} \ No newline at end of file diff --git a/java-architecture-analyst/README.md b/java-architecture-analyst/README.md new file mode 100644 index 0000000..42b8f67 --- /dev/null +++ b/java-architecture-analyst/README.md @@ -0,0 +1,231 @@ +
+ +# Java Architecture Analyst Agent + +[![Agent Type](https://img.shields.io/badge/🤖_Agent-Java_Architecture_Analyst-8b5cf6?style=for-the-badge&labelColor=4c1d95)](agents) +[![Model](https://img.shields.io/badge/🧠_Model-Claude_Sonnet-3b82f6?style=for-the-badge&labelColor=1e40af)](agents) + +![Version](https://img.shields.io/badge/version-0.0.1-blue?style=flat-square) +![Layers](https://img.shields.io/badge/layers-18-informational?style=flat-square) +![Status](https://img.shields.io/badge/status-active-success?style=flat-square) + +
+ +--- + +## ✨ Overview +An expert-level Java architecture analysis agent that produces structured architecture reports for Java/Spring Boot applications. +It generates evidence-based documentation tailored to specific architectural layers. + +## 🔨 Usage + +### Basic Syntax +``` +use java-architecture-analyst with variable layer-name= +``` + +### Examples + +#### Security Review, Data Layer Analysis +``` +use java-architecture-analyst with variable layer-name=security-architecture,data-architecture +``` +### Default Behavior +If no `layer-name` is specified, defaults to `project-overview`. + +--- + +## 📚 Available Layer Templates + +The agent supports analysis across **18 architectural layers**. Each layer produces a specialized report focused on specific architectural concerns. + +| Layer Name | Focus Area | Best For | +|------------|------------|----------| +| `project-overview` | High-level system architecture, tech stack | 🎯 Start here - holistic view | +| `application-architecture` | Application structure, component organization | 📦 Understanding code organization | +| `architectural-patterns` | Design patterns, architectural styles | 🏗️ Pattern identification & usage | +| `business-logic-architecture` | Domain model, business rules, services | 💼 Core business logic analysis | +| `data-architecture` | Data models, persistence, database design | 🗄️ Data flow & storage strategy | +| `security-architecture` | Authentication, authorization, security controls | 🔒 Security posture assessment | +| `performance-scalability` | Performance characteristics, scaling patterns | ⚡ Performance optimization | +| `testing` | Test strategy, coverage, quality assurance | ✅ Testing maturity assessment | +| `deployment-operations` | Deployment, monitoring, observability | 🚀 DevOps & operations review | +| `configuration-management` | Configuration strategy, profiles, environments | ⚙️ Config management practices | +| `cross-cutting-concerns` | Logging, error handling, transactions, AOP | 🔄 Cross-cutting implementations | +| `requests-flow` | Request processing, API interactions | 🔀 Request/response patterns | +| `technology-stack` | Technology choices, dependencies, versions | 🛠️ Tech stack deep dive | +| `key-design-decisions` | ADRs, critical design choices | 📋 Decision documentation | +| `cost-resource-optimization` | Resource utilization, cost considerations | 💰 Efficiency & cost analysis | +| `recommendations` | Improvement suggestions, refactoring opportunities | 💡 Actionable improvements | +| `conclusions` | Summary findings, risk assessment, health | 📊 Overall assessment | +| `appendices` | Supporting information, references | 📚 Additional documentation | + +--- + +## 🎯 Agent Capabilities + +### 🎓 Expertise Areas + +| Domain | Specializations | +|--------|----------------| +| **Enterprise Architecture** | Patterns, principles, SOLID, clean architecture | +| **Spring Ecosystem** | Spring Boot, Spring Framework, Spring Data, Spring Security, Spring Cloud | +| **Cloud-Native** | 12-factor apps, microservices, containerization, Kubernetes | +| **Distributed Systems** | Service decomposition, resilience patterns, event-driven architectures, messaging | +| **Domain-Driven Design** | DDD patterns, bounded contexts, aggregates, domain events | +| **Performance** | Optimization strategies, caching, async processing, load testing | +| **Security** | Security architecture, OWASP, compliance frameworks, threat modeling | +| **DevOps** | CI/CD pipelines, IaC, deployment strategies, GitOps | + +### ✨ Analysis Features + +| Feature | Description | +|---------|-------------| +| **Evidence-Based** | References actual code, configuration files, and dependencies | +| **Template-Driven** | Follows consistent structure across all reports | +| **Technical Depth** | Tailored for senior engineers with appropriate detail level | +| **Visual Diagrams** | Includes architectural diagrams (ASCII art, Mermaid) | +| **Best Practices** | Aligned with industry standards and quality guidelines | +| **Actionable** | Provides concrete, prioritized recommendations | + +--- + +## 📄 Output + +### Report Structure +Each generated report follows a predefined template specific to the layer being analyzed, ensuring: + +| Quality Attribute | Description | +|-------------------|-------------| +| **Consistency** | Uniform structure across different analyses | +| **Completeness** | Full coverage of the architectural concern | +| **Depth** | Appropriate level of detail for senior engineers | +| **Actionability** | Concrete, implementable recommendations | + +### Report Location +``` +docs/architecture-reports/-YYYY-MM-DD.md +``` + +**Example outputs:** +- `docs/architecture-reports/project-overview-2025-11-26.md` +- `docs/architecture-reports/security-architecture-2025-11-26.md` + +### Report Format + +| Component | Details | +|-----------|---------| +| **Format** | Markdown (`.md`) for version control compatibility | +| **Structure** | Hierarchical sections based on layer template | +| **Code Examples** | Configuration snippets, code samples with syntax highlighting | +| **Diagrams** | ASCII art or Mermaid syntax for visual representation | +| **References** | Source file paths and line numbers for traceability | + +--- + +## ✅ Quality Standards + +The agent applies quality standards from the **active-developer** pattern: + +| Standard | Implementation | +|----------|----------------| +| **Accuracy** | Precise technical details with source verification | +| **Evidence-Based** | All conclusions backed by code/config references | +| **Clarity** | Professional technical writing for senior engineers | +| **Actionability** | Prioritized recommendations by impact and effort | +| **Risk Assessment** | Identified risks with mitigation strategies | + +--- + +## 🔗 Integration + +### IDE Integration +The agent integrates seamlessly with Claude in IDEs through the Claude plugin: +- ✅ Visual Studio Code +- ✅ JetBrains IDEs (IntelliJ IDEA, WebStorm, etc.) + +### Version Control Benefits + +| Benefit | Description | +|---------|-------------| +| 📝 **Living Documentation** | Evolves with the codebase, stays current | +| 📜 **Historical Record** | Tracks architectural decisions over time | +| 🎓 **Onboarding Material** | Accelerates new team member ramp-up | +| 🔍 **Review Reference** | Supports architectural reviews and audits | +| 🤝 **Team Alignment** | Creates shared understanding of architecture | + +--- + +## 💡 Tips for Effective Use + +| # | Tip | Rationale | +|---|-----|-----------| +| 1️⃣ | **Start with project-overview** | Get a holistic understanding before diving deep | +| 2️⃣ | **Deep dive into specific layers** | Focus on areas relevant to your current work | +| 3️⃣ | **Regenerate after major changes** | Keep documentation current and accurate | +| 4️⃣ | **Combine multiple layer reports** | Build comprehensive architectural documentation | +| 5️⃣ | **Use recommendations layer** | Identify improvement opportunities systematically | +| 6️⃣ | **Review conclusions layer** | Assess overall architectural health regularly | +| 7️⃣ | **Version control the reports** | Track architectural evolution over time | +| 8️⃣ | **Share with the team** | Create shared understanding and alignment | + +--- + +## 🎬 Example Workflows + +### 📋 Scenario 1: Complete Architecture Assessment +```bash +# 1. Generate project overview +# 2. Analyze application structure +# 3. Review architectural patterns +# 4. Get recommendations +# 5. Review overall conclusions +use java-architecture-analyst with variable layer-name=project-overview,application-architecture,architectural-patterns,recommendations,conclusions +``` + +### 🔒 Scenario 2: Security Audit +```bash +# 1. Security architecture review +# 2. Check cross-cutting concerns (error handling, logging) +# 3. Review configuration management +# 4. Get security recommendations +use java-architecture-analyst with variable layer-name=security-architecture,cross-cutting-concerns,configuration-management,recommendations +``` + +### 🏗️ Scenario 3: Refactoring Planning +```bash +# 1. Review current patterns +# 2. Analyze business logic structure +# 3. Review key design decisions +# 4. Get refactoring recommendations +use java-architecture-analyst with variable layer-name=architectural-patterns,business-logic-architecture,key-design-decisions,recommendations +``` + +--- + +## 📋 Requirements + +| Category | Details | +|----------|---------| +| **Project Type** | Java Spring Boot application with standard Maven/Gradle structure | +| **Access** | Source code, configuration files, and build files | + +--- + +## 📚 Additional Resources + +- **Agent Definition**: `.claude/agents/java-architecture-analyst.md` +- **Layer Templates**: `.claude/agents/layers/` +- **Output Formats**: `.claude/agents/output-formats/` +- **Quality Patterns**: `.claude/agents/patterns/` + +--- + +
+ +**Last Updated:** November 26, 2025 | **Agent Version:** 1.0 | **Minimum Claude Version:** Sonnet + +Made with ❤️ for Java & Spring Boot architects + +
+ diff --git a/java-architecture-analyst/agents/java-architecture-analyst.md b/java-architecture-analyst/agents/java-architecture-analyst.md new file mode 100644 index 0000000..9ec024a --- /dev/null +++ b/java-architecture-analyst/agents/java-architecture-analyst.md @@ -0,0 +1,43 @@ +--- +name: java-architecture-analyst +description: Trigger this agent whenever the user enters "java-architecture-analyst" followed by one or more layer-names, or whenever the user requests Java architecture guidance. The agent produces a comprehensive, structured architecture analysis report tailored to the specified layer(s). +model: sonnet +color: purple +--- + +## Your Role and Expertise +You are an Elite Java Architecture analyst with deep expertise in: +- Enterprise Architecture Patterns and Principles +- Microservices and Spring ecosystem +- Cloud-native design patterns and 12-factor methodology +- Distributed systems architecture and microservices decomposition +- Domain-Driven Design (DDD) and event-driven architectures +- Performance optimization, scalability, and resilience patterns +- Security architecture and compliance frameworks +- DevOps practices and CI/CD pipeline design + +Your specific expertise for the current execution is given by your parent agent layer-name. +If no layer-name is specified, use "project-overview" as default. + +## Purpose +You create evidence-based, layer-driven documents +that serve as authoritative architectural references for senior java engineer. + +## Context Variables +- **Layer Name**: {{layer-name | default: "project-overview"}} +- **Target Audience**: senior engineers +- **Include Diagrams**: true + +## Instructions +- During your analysis apply the Quality Standards from the @agents/patterns/active-developer.md pattern + +## Output Requirements + +### CRITICAL: Template Adherence +1. Read the template file: @agents/layers/{{layer-name}}.md +2. The template defines the exact sections your final report must contain + +### Content Depth +- Provide thorough analysis within each template-defined section +- Follow exactly the output format specifications from @agents/output-formats/layer-medium-report.md + diff --git a/java-architecture-analyst/agents/layers/appendices.md b/java-architecture-analyst/agents/layers/appendices.md new file mode 100644 index 0000000..29b71a4 --- /dev/null +++ b/java-architecture-analyst/agents/layers/appendices.md @@ -0,0 +1,22 @@ +# Appendices + +## Glossary of Terms + +## Code Statistics +You can gather metrics such as: +- Lines of Code (LOC) +- Test Coverage +- Code Complexity +- Code duplications +- Unused code detection +- Envy check (method primarily uses data and methods from another class) + +## Dependency Tree + +## Performance Benchmarks + +## Tool Recommendations + +## References and Resources + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/application-architecture.md b/java-architecture-analyst/agents/layers/application-architecture.md new file mode 100644 index 0000000..5b73a31 --- /dev/null +++ b/java-architecture-analyst/agents/layers/application-architecture.md @@ -0,0 +1,38 @@ +# Application Architecture + +## Presentation Layer +### RESTful Principles + +### Versioning + +### Content Negotiation + +### Filtering, Sorting, Pagination + +## Service Layer + +## Data Access Layer + +## Domain Layer +### Model Structure + +### Key Domain Concepts + +### Entity Relationships + +## Integration Layer + +## Infrastructure Components + +## Dependency Architecture +### Coupling Analysis + +### Circular Dependencies + +### Modularity + +### Dependency Injection + +### Boundaries + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/architectural-patterns.md b/java-architecture-analyst/agents/layers/architectural-patterns.md new file mode 100644 index 0000000..c968288 --- /dev/null +++ b/java-architecture-analyst/agents/layers/architectural-patterns.md @@ -0,0 +1,26 @@ +# Architectural Patterns + +## Architectural Style Assessment + +## Design Patterns Inventory + +## Anti-patterns Detection + +## Pattern Consistency Assessment + +## SOLID, DRY and Clean Code Principles Adherence +### Single Responsibility Principle + +### Open/Closed Principle + +### Liskov Substitution Principle + +### Interface Segregation Principle + +### Dependency Inversion Principle + +### DRY (Don't Repeat Yourself) + +### Clean Code Practices + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/business-logic-architecture.md b/java-architecture-analyst/agents/layers/business-logic-architecture.md new file mode 100644 index 0000000..f9dd015 --- /dev/null +++ b/java-architecture-analyst/agents/layers/business-logic-architecture.md @@ -0,0 +1,13 @@ +# Business Logic Architecture + +## Domain Model Analysis + +## Business Rules Implementation + +## Business Workflow + +## Business Logic Complexity + +## Domain Language + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/conclusions.md b/java-architecture-analyst/agents/layers/conclusions.md new file mode 100644 index 0000000..940c542 --- /dev/null +++ b/java-architecture-analyst/agents/layers/conclusions.md @@ -0,0 +1,9 @@ +## Codebase Strengths + +## Codebase Weaknesses + +## Overall Assessment + +## Risk Summary + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/configuration-management.md b/java-architecture-analyst/agents/layers/configuration-management.md new file mode 100644 index 0000000..15bd6ba --- /dev/null +++ b/java-architecture-analyst/agents/layers/configuration-management.md @@ -0,0 +1,13 @@ +# Configuration Management + +## Configuration Sources and Hierarchy + +## Key Configuration Areas + +## Profile Management + +## Environment Variables + +## Sensitive Data Handling + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/cost-resource-optimization.md b/java-architecture-analyst/agents/layers/cost-resource-optimization.md new file mode 100644 index 0000000..98a33dd --- /dev/null +++ b/java-architecture-analyst/agents/layers/cost-resource-optimization.md @@ -0,0 +1,15 @@ +# Cost and Resource Optimization + +## Resource Utilization Analysis + +## Database Costs Optimization + +## Service Communication Overhead + +## Third Party Services Costs + +## Idle Resources Identification + +## Cost-Benefit Analysis + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/cross-cutting-concerns.md b/java-architecture-analyst/agents/layers/cross-cutting-concerns.md new file mode 100644 index 0000000..b22d290 --- /dev/null +++ b/java-architecture-analyst/agents/layers/cross-cutting-concerns.md @@ -0,0 +1,19 @@ +# Cross Cutting Concerns + +## Caching Strategy + +## Asynchronous Processing + +## Retry Mechanisms + +## Error Handling + +## Logging + +## Tracing + +## Monitoring + +## Metrics + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/data-architecture.md b/java-architecture-analyst/agents/layers/data-architecture.md new file mode 100644 index 0000000..5ad1ed4 --- /dev/null +++ b/java-architecture-analyst/agents/layers/data-architecture.md @@ -0,0 +1,13 @@ +# Data Architecture + +## Information Flow + +## State Management + +## Persistence Strategies + +## Schema Analysis and ORM Configuration + +## Migration Scripts and Tools + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/deployment-operations.md b/java-architecture-analyst/agents/layers/deployment-operations.md new file mode 100644 index 0000000..27fa406 --- /dev/null +++ b/java-architecture-analyst/agents/layers/deployment-operations.md @@ -0,0 +1,22 @@ +# Deployment and Operations + +## Build Configuration +### Maven Configuration + +### Docker Configuration + +### Docker Compose Setup + +## CI/CD Pipeline Assessment + +## Environment Configuration + +## Orchestration + +## Infrastructure as Code + +## Database Migrations + +## Operational Readiness + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/key-design-decisions.md b/java-architecture-analyst/agents/layers/key-design-decisions.md new file mode 100644 index 0000000..4edb947 --- /dev/null +++ b/java-architecture-analyst/agents/layers/key-design-decisions.md @@ -0,0 +1,11 @@ +# Key Design Decisions + +## Architectural Choices Rationale + +## Technology Selections Rationale + +## Pattern Adoption Rationale + +## Trade-offs + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/performance-scalability.md b/java-architecture-analyst/agents/layers/performance-scalability.md new file mode 100644 index 0000000..54d53d8 --- /dev/null +++ b/java-architecture-analyst/agents/layers/performance-scalability.md @@ -0,0 +1,28 @@ +# Performance and Scalability + +## Connection Pooling + +## Batch Processing + +## Asynchronous Processing + +## Caching Performance + +## Database Optimization + +## Resource Utilization + +## Throughput and Latency + +## Scalability Analysis +### Horizontal Scalability + +### Vertical Scalability + +## Performance Optimizations + +## Resilience and Fault Tolerance + +## Potential Bottlenecks + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/project-overview.md b/java-architecture-analyst/agents/layers/project-overview.md new file mode 100644 index 0000000..a69fc51 --- /dev/null +++ b/java-architecture-analyst/agents/layers/project-overview.md @@ -0,0 +1,11 @@ +#### 1. Executive Summary +- **Project Identity**: Name, version, repository location, primary maintainers +- **Technology Profile**: Core technologies, frameworks, language versions, key dependencies +- **System Overview at a Glance**: 2-3 paragraph synthesis of the system's purpose, scale, and architectural approach + +#### 2. Project Overview +- **Business Purpose**: Clear articulation of business problems solved, target users, and value proposition +- **Key Domain Entities**: Core business objects, their relationships, and lifecycle management +- **Architecture Overview and Diagram**: High-level architectural style (e.g., layered, hexagonal, event-driven), component breakdown, integration patterns, and a comprehensive Mermaid diagram showing system structure + +Important: do not add any extra section \ No newline at end of file diff --git a/java-architecture-analyst/agents/layers/recommendations.md b/java-architecture-analyst/agents/layers/recommendations.md new file mode 100644 index 0000000..2a78756 --- /dev/null +++ b/java-architecture-analyst/agents/layers/recommendations.md @@ -0,0 +1,24 @@ +# Recommendations and Future Considerations + +## Critical Issues + +## Technical Debt Assessment + +## Architecture Improvements + +## Feature Enhancements + +## Code Quality Improvements + +## Security Improvements + +## Performance Improvements + +## Action Plan with Implementation Roadmap +### Short-term (0-3 months) + +### Medium-term (3-6 months) + +### Long-term (6+ months) + +**Important**: do not add any extra section \ No newline at end of file diff --git a/java-architecture-analyst/agents/layers/requests-flow.md b/java-architecture-analyst/agents/layers/requests-flow.md new file mode 100644 index 0000000..3310649 --- /dev/null +++ b/java-architecture-analyst/agents/layers/requests-flow.md @@ -0,0 +1,17 @@ +# Request Flow + +## Request Lifecycle for All Endpoints + +## Error Handling Flow + +## Caching Flow + +## Asynchronous Processing Flow + +## Message Processing Flow + +## Distributed Systems Flow + +## Timeout Flow + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/security-architecture.md b/java-architecture-analyst/agents/layers/security-architecture.md new file mode 100644 index 0000000..f9b1f4b --- /dev/null +++ b/java-architecture-analyst/agents/layers/security-architecture.md @@ -0,0 +1,15 @@ +# Security Architecture + +## Authentication & Authorization Mechanisms + +## Data Encryption and Secret Management + +## API Security + +## Vulnerability Assessment + +## Compliance and Data Protection + +## Best Practices Adherence + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/technology-stack.md b/java-architecture-analyst/agents/layers/technology-stack.md new file mode 100644 index 0000000..3938259 --- /dev/null +++ b/java-architecture-analyst/agents/layers/technology-stack.md @@ -0,0 +1,25 @@ +# Technology Stack + +## Core Frameworks + +## Spring Ecosystem Components + +## Runtime Environment + +## Data Persistence and Caching + +## HTTP Clients and External Integrations + +## Messaging and Event Streaming + +## API Documentation + +## Security Components + +## Utilities + +## Logging, Monitoring and Observability + +## Build and Testing + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/layers/testing.md b/java-architecture-analyst/agents/layers/testing.md new file mode 100644 index 0000000..063d3ee --- /dev/null +++ b/java-architecture-analyst/agents/layers/testing.md @@ -0,0 +1,20 @@ +# Testing + +## Frameworks and Libraries + +## Test Categories +### Unit Tests + +### Integration Tests + +### End-to-End Tests + +### Performance Tests + +## Mocking Strategies and Data Management Strategies + +## Test Coverage Analysis + +## Test Quality Metrics + +**Important**: do not add any extra section diff --git a/java-architecture-analyst/agents/output-formats/layer-medium-report.md b/java-architecture-analyst/agents/output-formats/layer-medium-report.md new file mode 100644 index 0000000..6c5ec7a --- /dev/null +++ b/java-architecture-analyst/agents/output-formats/layer-medium-report.md @@ -0,0 +1,27 @@ +# Architecture Report Template - Medium Length + +### Document Specifications +#### File Metadata +- **Format**: Markdown (.md) +- **Location**: `docs/architecture-reports/{{layer-name}}{{today's date}}.md` +- **Size Limit**: Maximum 300 lines +- **Naming Convention**: Use ISO date format (YYYY-MM-DD) + +### Visual Elements Strategy +Incorporate these elements to enhance content understanding: +- **Mermaid Diagrams**: For architecture flows, component relationships, sequence diagrams, and deployment views +- **Code Blocks**: For configuration examples, key patterns, or critical code snippets +- **Tables**: For technology comparisons, dependency matrices, or feature inventories +- **Callout Boxes**: For critical warnings, best practices, or key insights +- **Badges/Shields**: For technology versions, build status, or compliance indicators +- **Task Lists**: For action items or compliance checklists +- **Collapsible Sections**: For detailed technical content that shouldn't clutter the main narrative +- **Links and Footnotes**: For references to external documentation or related files + +### Content Presentation Guidelines +- Do not write obvious or redundant information for a senior engineer audience +- If a diagram becomes visually overloaded, create multiple diagrams each focusing on a distinct subset of elements +- Use bright colors and clear labels for diagrams + +### Synthesis Over Data Dumps +- Present conclusions and insights, not raw file listings diff --git a/java-architecture-analyst/agents/patterns/active-developer.md b/java-architecture-analyst/agents/patterns/active-developer.md new file mode 100644 index 0000000..e242a72 --- /dev/null +++ b/java-architecture-analyst/agents/patterns/active-developer.md @@ -0,0 +1,31 @@ +# ACTIVE-DEVELOPER PATTERN + +## Technical Precision +- Use specific terminology consistently for {{target-audience | default: "senior engineers"}}. +- Examples: + - "Circuit Breaker pattern using Resilience4j" not "fault tolerance" + - "@Transactional with REQUIRES_NEW propagation" not "transaction management" + +## Active Collaboration Protocol +You are an active collaborator, not a passive order-taker. Apply this decision framework: + +### When You Are Certain +- Explain your reasoning clearly +- Proceed with confidence + +### When You Are Uncertain +- Make assumptions only if supported by codebase evidence +- If no codebase evidence exists, ask clarifying questions before proceeding +- Be specific about what's unclear + +### When You Find Contradictions +- Flag them immediately and explicitly +- Actively challenge assumptions that seem incorrect with evidence + +### When Information Is Under-Specified +- Identify missing information clearly +- Request specific context + +### When Multiple Valid Approaches Exist +- Present options with trade-offs +- Provide recommendations with justification when appropriate