Appearance
Synapse Studios Development Documentation
This repository contains comprehensive documentation for development practices, design guidelines, and best practices at Synapse Studios.
Documentation Structure
Our documentation is organized into two main categories:
📚 Concepts
Foundational knowledge - the "what" and "why" behind our practices
Architecture
| Article | Description |
|---|---|
| Coupling and Cohesion | The fundamental forces that shape software architecture |
| Clean Architecture | The architectural philosophy that guides system design at Synapse |
| Modular Monolith | Building well-structured single applications ready to evolve |
| Dependency Inversion & Ports/Adapters | Building flexible, testable systems through dependency inversion |
Patterns
| Article | Description |
|---|---|
| Use Cases | Application-specific business rules and orchestration patterns |
| Repository | Abstracting data persistence with domain-focused interfaces |
| Page Object | Abstracting UI interactions through declarative, reusable test components |
Testing
| Article | Description |
|---|---|
| Unit Testing | Pragmatic approaches to unit testing focused on design feedback |
| Test-Driven Development | Using TDD as a tool for running and validating code as you write it |
| Backend Integration Testing | Testing strategies for databases, APIs, and external services |
| Frontend Testing | Component, interaction, and visual testing for UI applications |
| Acceptance Testing | Business-focused testing with layered architecture |
CI/CD
| Article | Description |
|---|---|
| Continuous Integration | Integrating work frequently with automated verification |
| Continuous Delivery | Ensuring software is always deployable through automated pipelines |
Practices
| Article | Description |
|---|---|
| Code Smells | Surface signals of deeper design problems, from Fowler and Martin |
| Postmortems | Blameless investigations that help teams learn from failures |
| Formal Postmortem Template | Template for comprehensive analysis of critical incidents |
🔧 Implementation
Practical guides - the "how" of applying concepts in specific technologies
Frameworks
| Article | Description |
|---|---|
| NestJS Implementation Guide | Complete guide to building NestJS applications with Clean Architecture |
| React Design Guidelines | Component design patterns and UI/UX standards for React applications |
| Next.js Best Practices | Configuration, optimization, and development practices for Next.js applications |
| Vite Best Practices | Configuration, optimization, and development practices for Vite-based React applications |
Testing
| Article | Description |
|---|---|
| Acceptance Testing Guidelines | End-to-end and integration testing strategies |
| NestJS API Testing Guidelines | Testing strategies for NestJS backend APIs |
| React Testing Guidelines | Testing strategies and practices for React applications |
CI/CD
| Article | Description |
|---|---|
| Multi-Stage Pipeline with GitHub Actions | Complete guide to implementing deployment pipelines using GitHub Actions workflows |
| Deploying to AWS ECS | ECS deployments with colocated task definitions, blue-green strategies, and cross-account deployment patterns |
Code Quality
| Article | Description |
|---|---|
| Code Smells | Surface signals of deeper design problems, from Fowler and Martin |
Usage
This documentation repository is designed to be consumed by coding agents and development teams to standardize and enforce best practices across all Synapse Studios projects.