Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions architectures/agentic-architecture/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ last_updated: 2026-04-17
</div>

---

## 🧱 Core Principles

1. **Isolation & Testability:** Specialized agents can be tested and tuned in isolation from the orchestrator.
2. **Strict Boundaries:** Enforce rigid responsibilities between planners, coders, and reviewers.
3. **Decoupling:** Decouple context gathering from action execution to optimize token usage.

## 🗺️ Map of Patterns (Agentic Modules)

This architecture defines the operational boundaries for multi-agent workflows, specifically optimizing for context windows, token efficiency, and deterministic output.
Expand All @@ -31,6 +38,8 @@ This architecture defines the operational boundaries for multi-agent workflows,
- ⚖️ **Trade-offs:** Latency vs. Reasoning depth.
- 🛠️ **Implementation Guide:** Rules for defining strict agent personas and constraints.

## 📐 Architecture Diagram

```mermaid
graph TD
User[User Request] --> Orchestrator[Orchestrator Agent]
Expand Down
4 changes: 3 additions & 1 deletion architectures/backend-for-frontend/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ last_updated: 2026-03-29

This engineering directive defines the **best practices** for the Backend-For-Frontend (BFF) architecture. This document is designed to ensure maximum scalability, security, and code quality when developing applications that require tailored APIs for different clients (e.g., web, mobile).

# Context & Scope
## 🎯 Context & Scope
- **Primary Goal:** Provide strict architectural rules and practical patterns for creating specialized backend services dedicated to specific frontend applications.
- **Description:** A pattern where a separate backend service is created for each specific frontend application or interface type, rather than having a single general-purpose API backend for all clients.

Expand All @@ -38,6 +38,8 @@ This engineering directive defines the **best practices** for the Backend-For-Fr
| **Complexity** | Multiple BFFs to manage | Single point of failure/bottleneck |


## 📐 Architecture Diagram

```mermaid
graph TD
Web[Web Client] --> BFF_Web[BFF Web]
Expand Down
23 changes: 22 additions & 1 deletion architectures/feature-sliced-design/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,33 @@ last_updated: 2026-03-22
<img src="https://feature-sliced.design/img/brand/logo-primary.png" width="100" alt="FSD Logo">

# 🍰 Feature-Sliced Design (FSD)

</div>

---

## 🎯 Context & Scope
- **Primary Goal:** Establish definitive rules and best practices for modular, scalable frontend development.
- **Target Tooling:** AI Agents and Human Developers.
- **Tech Stack Version:** Agnostic (React, Vue, Angular)

---
This engineering directive contains strict architectural guidelines and 20 practical patterns for using the Feature-Sliced Design methodology to build scalable and deterministic Frontend applications.



## 🗺️ Map of Patterns
- 🌊 **Data Flow:** Layer-to-layer execution paths and slice interactions.
- 📁 **Folder Structure:** Strict vertical (slices) and horizontal (layers) isolation.
- ⚖️ **Trade-offs:** Initial overhead vs. long-term maintainability.
- 🛠️ **Implementation Guide:** Rules for cross-imports and boundaries.

## 🧱 Core Principles

1. **Isolation & Testability:** Slices are completely isolated, making them highly testable and refactorable.
2. **Strict Boundaries:** Enforce strict cross-import boundaries (lower layers cannot import from higher layers).
3. **Decoupling:** Decouple business logic into cohesive modules rather than scattering it across technical layers.

### Structural Comparison: Feature-Sliced Design vs Clean Architecture

| Feature | Feature-Sliced Design (FSD) | Clean Architecture |
Expand All @@ -28,7 +49,7 @@ This engineering directive contains strict architectural guidelines and 20 pract
| **Learning Curve** | High (Strict structural rules) | High (Abstract concepts) |
| **Scalability** | Excellent for large frontend teams | Excellent for complex enterprise backends |

## Architecture Diagram
## 📐 Architecture Diagram

```mermaid
graph TD
Expand Down
9 changes: 9 additions & 0 deletions architectures/hexagonal-architecture/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ last_updated: 2026-03-22
**Ports and Adapters for scalable, testable code.**
</div>
---

## 🧱 Core Principles

1. **Isolation & Testability:** The Domain is strictly isolated from infrastructure, allowing unit testing via Ports.
2. **Strict Boundaries:** Enforce rigid boundaries using Ports and Adapters to separate business logic from technical details.
3. **Decoupling:** Decouple the Core logic from databases, external APIs, and UIs.

## 🗺️ Map of Patterns (Hexagonal Modules)

This pattern documentation has been decomposed into specialized modules for zero-approval AI parsing and human comprehension.
Expand All @@ -29,6 +36,8 @@ This pattern documentation has been decomposed into specialized modules for zero
- ⚖️ **[Trade-offs](./trade-offs.md):** Pros, cons, and architectural constraints.
- 🛠️ **[Implementation Guide](./implementation-guide.md):** Step-by-step rules and code constraints for Vibe Coding.

## 📐 Architecture Diagram

```mermaid
flowchart TD
A[External System/User] -->|Calls Port| B(Adapter)
Expand Down
9 changes: 9 additions & 0 deletions architectures/microkernel-architecture/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ last_updated: 2026-04-18
</div>

---

## 🧱 Core Principles

1. **Isolation & Testability:** Plugins can be tested in complete isolation from the core.
2. **Strict Boundaries:** Enforce rigid structural barriers between the core microkernel and plugins.
3. **Decoupling:** Decouple volatile domain logic from the stable core application logic.

## 🗺️ Map of Patterns (Microkernel Modules)

This architecture defines strict boundaries between a minimal core system and extended functionalities implemented as standalone plugins. It guarantees O(1) impact on the core when adding or modifying auxiliary features.
Expand All @@ -33,6 +40,8 @@ This architecture defines strict boundaries between a minimal core system and ex
- ⚖️ **Trade-offs:** Extensibility vs. Contract Management complexity.
- 🛠️ **Implementation Guide:** Rules for defining strict interface boundaries and registry mechanisms.

## 📐 Architecture Diagram

```mermaid
graph TD
Core[Core System / Microkernel] --> Registry[Plugin Registry]
Expand Down
4 changes: 3 additions & 1 deletion architectures/microservices/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ last_updated: 2026-03-29
---

This engineering directive defines the **best practices** for the Microservices architecture. This document is designed to ensure maximum scalability, security, and code quality when developing enterprise-level applications.
# Context & Scope
## 🎯 Context & Scope
- **Primary Goal:** Provide strict architectural rules and practical patterns for creating scalable systems.
- **Description:** Breaking down a giant monolithic system into small, independent pieces, each handling its own business capability. Each service has its own Database.
## Map of Patterns
Expand All @@ -39,6 +39,8 @@ This engineering directive defines the **best practices** for the Microservices
2. **Strict Boundaries:** Enforce rigid structural barriers between business logic and infrastructure.
3. **Decoupling:** Decouple how data is stored from how it is queried and displayed.

## 📐 Architecture Diagram

```mermaid
graph LR
Isolation[Isolation & Testability] --- Boundaries[Strict Boundaries]
Expand Down
11 changes: 10 additions & 1 deletion architectures/model-view-controller/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ last_updated: 2026-03-22
---

This engineering directive defines the **best practices** for the MVC architecture. This document is designed to ensure maximum scalability, security, and code quality when developing enterprise-level applications.
# Context & Scope
## 🎯 Context & Scope
- **Primary Goal:** Provide strict architectural rules and 20 practical patterns for creating scalable and deterministic MVC applications.
- **Target Tooling:** AI Agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Developers.
- **Tech Stack Version:** Agnostic (Applicable to Node.js, NestJS, Express, Spring Boot, Django, ASP.NET, etc.).
Expand All @@ -24,6 +24,8 @@ This engineering directive defines the **best practices** for the MVC architectu
> **Architectural Contract:** The Controller receives the HTTP request and routes commands, Services (or Domain Model) contain the business logic, and the View is strictly responsible for rendering abstract Data Transfer Objects (DTOs).
## Architecture Flow (Mental Model)

## 📐 Architecture Diagram

```mermaid
graph TD
User([User Request]) --> Router[Router]
Expand Down Expand Up @@ -59,6 +61,13 @@ graph TD
- 📁 [**Folder Structure:** Layering logic](./folder-structure.md)
- ⚖️ [**Trade-offs:** Pros, Cons, and System Constraints](./trade-offs.md)
- 🛠️ [**Implementation Guide:** Code patterns and Anti-patterns](./implementation-guide.md)

## 🧱 Core Principles

1. **Isolation & Testability:** Views and Models are isolated from each other via Controllers.
2. **Strict Boundaries:** Enforce rigid structural boundaries between UI, logic, and data.
3. **Decoupling:** Decouple the UI from business logic to enable independent development.

## 1. Fat Controllers (God Object Controller)

### ❌ Bad Practice
Expand Down
Loading