Skip to content

Onboarding

Narrative entry path for engineers joining a project that consumes Engineering Standards. AI agents SHOULD use AGENTS.md and standards.manifest.json instead of this guide for routine implementation.


What you are working with

Your application repository pins this standards repository (usually as a standards/ git submodule). The standards define how to structure code, tests, and documentation. Your project defines what the business does under docs/domain/.

Tri-layer naming is intentional: the same use case name appears in docs/domain/{feature}/{use-case}.md, backend {Feature}/{UseCase}/, and frontend features/{feature}/{use-case}/. You can follow the same name across layers without a separate map.


Before your first line of code

  1. Read the project root AGENTS.md shim (points at standards/AGENTS.md and lists project-specific rules).
  2. Skim standards/docs/architecture/clean-architecture.md for layer boundaries.
  3. Open docs/domain/README.md in the project repo for features and doc status.
  4. Open the feature README and use case doc for the task you were assigned.
  5. Load Tier 1 Quick Rules from agentLoadPlans in standards/standards.manifest.json. Use the use case doc layer-context frontmatter when present (for example backend.application, backend.api, frontend.app). Load Tier 2 full conventions only when a Quick Rule is unclear.

Do not read docs/philosophy.md or docs/decisions/ unless you are choosing a new dependency or understanding a historical trade-off.


First implementation task (typical use case)

StepWhere
Understand behaviordocs/domain/{feature}/{use-case}.md
Understand tests expecteddocs/domain/{feature}/{use-case}.tests.md
Implement backendFollow docs/guides/add-new-use-case.md and layer conventions
Implement frontendSame guide; page composition doc under docs/ui/{app}/pages/ when applicable
VerifyProject commands in shim AGENTS.md; gates in standards/docs/conventions/shared/ci.md
Finishstandards/docs/guides/definition-of-done.md

If operation or test docs are missing, write them first per docs/guides/write-use-case-doc.md before coding.


Where to look things up

QuestionDocument
Term definitions (Reactions, Spec sync rule, context tiers, tags)standards/docs/glossary.md
All convention file pathsstandards/standards.manifest.jsonconventionIndex
Why a stack choice existsstandards/docs/decisions/README.md (humans; not routine agent load)
Copy-paste scaffoldsstandards/docs/blueprints/README.md
Domain doc templatesstandards/docs/templates/docs/
CI and Docker templatesstandards/docs/templates/config/
Operations (deploy, rollback)standards/docs/runbooks/README.md
Reference consumer monorepoLitePress

Common mistakes

  • Treating docs/domain/ content as optional after the first sprint (docs drift causes wrong agent and human behavior).
  • Using Guard.Against in validators (maps to HTTP 500). See docs/conventions/backend/exception-hierarchy.md.
  • Injecting repositories into query handlers (use IDatabaseContext only).
  • Cross-feature imports in Next.js features/ folders.
  • Upgrading package versions without checking standards.manifest.json pins.

DocumentAudience
README.md (standards repo root)Submodule setup and versioning
docs/README.mdDocumentation map
docs/guides/agentic-domain-driven-design.mdDomain documentation system
docs/philosophy.mdLong-form rationale (optional read)