Effect TDFDDD Template Documentation
Welcome to the documentation for the Effect Type-Driven Functional Domain-Driven Design template. This repo uses a modified Diátaxis structure so the docs serve both of these jobs:
- teach humans how to understand and practice the method
- help humans review LLM-generated design artifacts with confidence
Start here by goal
I want to learn the method by hand
Read these in order:
- TDFDDD Manifesto
- By-hand practice guide
- Worked Example: Truck Loading
- Practicing TDFDDD by Hand
- Design Artifact Template
I want to review LLM-generated design output
Read these in order:
- TDFDDD Manifesto
- Worked Example: Truck Loading
- How to Review an LLM-Generated Design
- Review Checklist for TDFDDD Artifacts
- TDFDDD Protocol for the design and implementation security verification gates
Tutorials
Learning-oriented guides for building intuition through examples and practice.
How-to guides
Task-oriented guides for doing specific work.
Explanation
Understanding-oriented material for the ideas, tradeoffs, and philosophy behind the method.
- TDFDDD Manifesto
- TDFDDD Protocol
- Naming for Domain Modeling
- Why Events, Not Booleans
- Architecture Reasoning
- Bounded Context Architecture Statement
- Architecture Rationale Summary
- Security Verification Rationale
Reference
Information-oriented material for lookups, templates, and stable rules.
- Directory Layout
- Project Structure Overview
- Conventions
- Rule Examples
- Naming Lexicon
- Review Checklist for TDFDDD Artifacts
- Design Artifact Template
- Design Artifact Structure
By-hand practice
Human-first material for learning the original 5-phase design flow manually.
Agent Guidance
If you are an AI agent working in this repository, consult .agents/ or AGENTS.md for operational rules. Contextual rules are loaded based on the files you edit.