Skip to content
Waqas Khan Pitafi
Founder and CEO, DevBatch · Dallas

Starter kit

starter-kit/design/architecture.md

One file from the portable method that ships with the book.

starter-kit / design / architecture.md

# Technical Design — <project> (v0.1)

> Phase 2 artifact. Locked before build. Architecture must satisfy the spec with **no orphan
> requirements**, and **isolate volatile logic** (rules/calculations) so it can change without a rebuild.

## 1. Overview & key decisions
<!-- The shape of the system + the decisions that matter (and why). -->

## 2. Modules & responsibilities
<!-- The layers/modules and what each owns. Keep pure logic separate from I/O. -->

## 3. Data model
<!-- Tables/collections, keys, constraints. Maps to spec §4. -->

## 4. The rule / calculation engine (isolated — MUST-6)
<!-- The volatile business rules, kept as pure, testable functions with no I/O. -->

## 5. API / interface surface
<!-- Endpoints/actions, request/response contracts. -->

## 6. Security architecture
<!-- Auth model + enforcement, secrets, transport, audit. Enforcement must be testable against a
     real exposed config (learned the hard way: "auth exists" ≠ "auth enforced"). -->
Prefer the whole thing at once? Download the starter kit as a zip. The files here and the files in the zip are the same.