Skip to content

Development Documentation

This folder contains development guides, processes, and quality management for Forma3D.Connect.

Contents

Document Description
implementation-plan.md Phased implementation plan and milestones
trunk-based-development-workflow.md Git branching strategy and workflow
AI-implementation-advantage.md Case study: 17.5x acceleration with AI-powered development

Testing & Quality Assurance

Document Description
real-world-testing.md End-to-end testing guide with Shopify, SimplyPrint, and Sendcloud
load-testing.md K6 load testing guide with pipeline integration

Operations & Production Readiness (Phase 6)

Document Description
runbook.md Operations runbook with incident response procedures
troubleshooting.md Common issues and their resolutions
environment-setup.md Local development environment setup guide
keys-certificates-inventory.md API keys, secrets, and certificates inventory
security-audit-checklist.md Security audit checklist for Aikido verification

Technical Debt Management

Document Description
techdebt/technical-debt-register.md Technical debt register with prioritized remediation plan
techdebt/managing technical debt.pdf Reference: "Managing Technical Debt" (Kruchten, Nord, Ozkaya)

Development Standards

This project follows strict development standards defined in .cursorrules:

  • TypeScript Strict Mode - No any types or ts-ignore comments
  • Layered Architecture - UI → Domain → API Client → Backend → Database
  • NestJS Backend - Controllers for HTTP, Services for logic, Repositories for data
  • React 19 Frontend - Functional components, hooks for logic, TanStack Query for server state
Document Description
Architecture Technical architecture and ADRs
Deployment Deployment guides
Requirements Feature requirements