designing-architecture_skill
- Python
1.2k
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill cloudai-x/claude-workflow-v2 --skill designing-architecture- SKILL.md6.6 KB
Overview
This skill designs software architecture and recommends suitable patterns for projects of varying size and complexity. It helps structure codebases, choose between monoliths and microservices, and document trade-offs for technical decisions. The guidance focuses on pragmatic choices that match team skills and business requirements.
How this skill works
It assesses requirements, constraints, project and team size, then suggests architecture patterns (layered, clean, hexagonal, event-driven, CQRS) and directory structures. It provides a decision framework, a trade-off template, and validation checklists to justify and verify choices. The outputs include recommended patterns, directory organization, and a documented rationale for the selected approach.
When to use it
- Starting a new project and choosing the overall architecture
- Refactoring or splitting a monolith into modules or services
- Evaluating microservices vs modular monolith trade-offs
- Designing for scalability, testability, or replaceable integrations
- Preparing architecture decision records for stakeholders
Best practices
- Start with the simplest pattern that meets requirements and evolve when necessary
- Match architecture to team skills and expected project growth
- Document decisions with context, options, trade-offs, and consequences
- Define clear module or layer boundaries and enforce dependency directions
- Validate architecture with a checklist covering requirements, team fit, testing, and boundaries
Example use cases
- Small CRUD app: use layered/MVC with simple controllers and models for fast delivery
- Medium product with growing business rules: adopt Clean Architecture and feature-based directory layout
- Large system with many teams: prefer modular monolith or justified microservices and document split criteria
- Integration-heavy app: use Hexagonal (ports & adapters) to keep core independent of external systems
- High-throughput async processing: design event-driven components with clear producer/consumer boundaries
FAQ
Evaluate team size, operational maturity, coupling between domains, and deployment complexity. Prefer a modular monolith until microservices are justified by independent scaling, team autonomy, or domain boundaries.
When should I use CQRS or event sourcing?
Use CQRS when read/write workloads have different scaling needs or when read models must be highly optimized. Combine with event sourcing if auditability, temporal queries, or reconstruction of state are required; otherwise weigh added complexity.
