home / skills / zpankz / mcp-skillset / software-architecture

software-architecture skill

/software-architecture

This skill helps you design maintainable, domain-driven software architectures by applying clean architecture, modularization, and library-first guidance

This is most likely a fork of the software-architecture skill from xfstudio
npx playbooks add skill zpankz/mcp-skillset --skill software-architecture

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.5 KB
---
name: software-architecture
description: Guide for quality focused software architecture. This skill should be used when users want to write code, design architecture, analyze code, in any case that relates to software development. 
---

# Software Architecture Development Skill

This skill provides guidance for quality focused software development and architecture. It is based on Clean Architecture and Domain Driven Design principles.

## Code Style Rules

### General Principles

- **Early return pattern**: Always use early returns when possible, over nested conditions for better readability
- Avoid code duplication through creation of reusable functions and modules
- Decompose long (more than 80 lines of code) components and functions into multiple smaller components and functions. If they cannot be used anywhere else, keep it in the same file. But if file longer than 200 lines of code, it should be split into multiple files.
- Use arrow functions instead of function declarations when possible

### Best Practices

#### Library-First Approach

- **ALWAYS search for existing solutions before writing custom code**
  - Check npm for existing libraries that solve the problem
  - Evaluate existing services/SaaS solutions
  - Consider third-party APIs for common functionality
- Use libraries instead of writing your own utils or helpers. For example, use `cockatiel` instead of writing your own retry logic.
- **When custom code IS justified:**
  - Specific business logic unique to the domain
  - Performance-critical paths with special requirements
  - When external dependencies would be overkill
  - Security-sensitive code requiring full control
  - When existing solutions don't meet requirements after thorough evaluation

#### Architecture and Design

- **Clean Architecture & DDD Principles:**
  - Follow domain-driven design and ubiquitous language
  - Separate domain entities from infrastructure concerns
  - Keep business logic independent of frameworks
  - Define use cases clearly and keep them isolated
- **Naming Conventions:**
  - **AVOID** generic names: `utils`, `helpers`, `common`, `shared`
  - **USE** domain-specific names: `OrderCalculator`, `UserAuthenticator`, `InvoiceGenerator`
  - Follow bounded context naming patterns
  - Each module should have a single, clear purpose
- **Separation of Concerns:**
  - Do NOT mix business logic with UI components
  - Keep database queries out of controllers
  - Maintain clear boundaries between contexts
  - Ensure proper separation of responsibilities

#### Anti-Patterns to Avoid

- **NIH (Not Invented Here) Syndrome:**
  - Don't build custom auth when Auth0/Supabase exists
  - Don't write custom state management instead of using Redux/Zustand
  - Don't create custom form validation instead of using established libraries
- **Poor Architectural Choices:**
  - Mixing business logic with UI components
  - Database queries directly in controllers
  - Lack of clear separation of concerns
- **Generic Naming Anti-Patterns:**
  - `utils.js` with 50 unrelated functions
  - `helpers/misc.js` as a dumping ground
  - `common/shared.js` with unclear purpose
- Remember: Every line of custom code is a liability that needs maintenance, testing, and documentation

#### Code Quality

- Proper error handling with typed catch blocks
- Break down complex logic into smaller, reusable functions
- Avoid deep nesting (max 3 levels)
- Keep functions focused and under 50 lines when possible
- Keep files focused and under 200 lines of code when possible
```

Overview

This skill is a practical guide for quality-focused software architecture grounded in Clean Architecture and Domain-Driven Design. It provides concrete rules, naming guidance, anti-patterns, and code-style recommendations to help teams write maintainable, testable, and clear code. Use it to shape architecture decisions, code reviews, and implementation patterns across services and applications.

How this skill works

The skill inspects design and implementation choices against a set of principles: separation of concerns, explicit use-case boundaries, library-first decision-making, and limited file/function size. It highlights anti-patterns such as NIH syndrome, generic dumping-ground modules, and mixing business logic with UI or controllers. It translates those principles into actionable rules for naming, file layout, error handling, and code decomposition.

When to use it

  • Designing or reviewing service or module-level architecture
  • Writing or refactoring business logic and use-case implementations
  • Establishing code-style rules for an engineering team
  • Choosing between a third-party library and custom implementation
  • Conducting code reviews focused on maintainability and separation of concerns

Best practices

  • Prefer existing libraries and SaaS for common tasks; justify custom code with concrete constraints
  • Follow Clean Architecture and DDD: isolate domain entities, use cases, and infrastructure
  • Use domain-specific names (e.g., OrderCalculator) instead of generic folders like utils
  • Keep functions focused (ideally <50 lines) and files under ~200 lines; split long components early
  • Adopt early-return patterns, limit nesting to three levels, and de-duplicate via reusable modules
  • Handle errors explicitly, prefer typed catches, and isolate performance- or security-critical paths

Example use cases

  • Refactoring a monolithic controller by moving database queries into repository/adapters
  • Choosing whether to integrate a retry library or implement custom retry logic for a service
  • Defining module and file layout for a new bounded context (orders, billing, users)
  • Creating code-review checklists that flag NIH patterns and generic 'utils' files
  • Designing use-case classes that encapsulate single business processes for easier testing

FAQ

When is custom code acceptable over a library?

When the logic is domain-specific, performance-critical, security-sensitive, or when available libraries were evaluated and found insufficient.

How should I name shared functionality?

Prefer domain-specific module names tied to intent or bounded context; avoid broad names like utils, helpers, or shared.