Skip to main content

Folder contract

Every microproduct—even experimental prototypes—is easier to shepherd when it conforms to one predictable repo shape.

products/
<product-id>/
README.md
AGENTS.md
product.yaml
product-brief.md
architecture.md
data-contract.md
evaluation.md
roadmap.md
demo.md
src/
tests/

In practice your repository root is the <product-id> folder—omit the redundant products/ prefix unless you deliberately group multiples in a monorepo.

Markdown contract purposes

FilePurpose
README.mdOrientation, onboarding, badges, screenshots
AGENTS.mdProduct-local instructions tuned for collaborator agents
product.yamlMachine-readable mirror of /schemas/product.schema.json
product-brief.mdUsers, pains, wedge, non-goals
architecture.mdBounded context diagrams, integrations, infra
data-contract.mdInputs, freshness, lineage, privacy tiers
evaluation.mdMetrics, thresholds, rollback triggers
roadmap.mdNext bets and explicit rejects
demo.mdScripts for humans and bots to replay happy paths

Implementation directories

PathResponsibility
src/Application code respecting the documented architecture
tests/Unit, contract, synthesis, smoke—match maturity depth

Agents must keep these files synced when scope changes—even if temporarily stubbed—to avoid silent divergence between humans and tooling.