Initial commit

2026-05-25 05:47:28 +00:00
commit 4d6495ffda
97 changed files with 13403 additions and 0 deletions
@@ -0,0 +1,82 @@
+# 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](https://diataxis.fr/) 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:
+
+1. [TDFDDD Manifesto](explanation/tdfddd-manifesto.md)
+2. [By-hand practice guide](by-hand/README.md)
+3. [Worked Example: Truck Loading](tutorials/worked-example-truck-loading.md)
+4. [Practicing TDFDDD by Hand](tutorials/practicing-tdfddd-by-hand.md)
+5. [Design Artifact Template](reference/design-artifact-template.md)
+
+### I want to review LLM-generated design output
+
+Read these in order:
+
+1. [TDFDDD Manifesto](explanation/tdfddd-manifesto.md)
+2. [Worked Example: Truck Loading](tutorials/worked-example-truck-loading.md)
+3. [How to Review an LLM-Generated Design](how-to/review-an-llm-generated-design.md)
+4. [Review Checklist for TDFDDD Artifacts](reference/review-checklist.md)
+5. [TDFDDD Protocol](explanation/tdfddd-protocol.md) for the design and implementation security verification gates
+
+## Tutorials
+
+_Learning-oriented guides for building intuition through examples and practice._
+
+- [Effect Starting Guide](tutorials/effect-starting-guide.md)
+- [Worked Example: Truck Loading](tutorials/worked-example-truck-loading.md)
+- [Practicing TDFDDD by Hand](tutorials/practicing-tdfddd-by-hand.md)
+
+## How-to guides
+
+_Task-oriented guides for doing specific work._
+
+- [Implementation Guide](how-to/implementation-guide.md)
+- [How to Review an LLM-Generated Design](how-to/review-an-llm-generated-design.md)
+
+## Explanation
+
+_Understanding-oriented material for the ideas, tradeoffs, and philosophy behind the method._
+
+- [TDFDDD Manifesto](explanation/tdfddd-manifesto.md)
+- [TDFDDD Protocol](explanation/tdfddd-protocol.md)
+- [Naming for Domain Modeling](explanation/naming-for-domain-modeling.md)
+- [Why Events, Not Booleans](explanation/why-events-not-booleans.md)
+- [Architecture Reasoning](explanation/architecture/index.md)
+- [Bounded Context Architecture Statement](explanation/architecture/bounded-contexts.md)
+- [Architecture Rationale Summary](explanation/architecture/rationale-summary.md)
+- [Security Verification Rationale](explanation/architecture/security-verification-rationale.md)
+
+## Reference
+
+_Information-oriented material for lookups, templates, and stable rules._
+
+- [Directory Layout](reference/directory-layout.md)
+- [Project Structure Overview](reference/overview.md)
+- [Conventions](reference/conventions.md)
+- [Rule Examples](reference/rule-examples.md)
+- [Naming Lexicon](reference/naming-lexicon.md)
+- [Review Checklist for TDFDDD Artifacts](reference/review-checklist.md)
+- [Design Artifact Template](reference/design-artifact-template.md)
+- [Design Artifact Structure](reference/design-artifact-structure.md)
+
+## By-hand practice
+
+_Human-first material for learning the original 5-phase design flow manually._
+
+- [By-hand practice guide](by-hand/README.md)
+
+---
+
+## 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.