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
- Read the project root
AGENTS.mdshim (points atstandards/AGENTS.mdand lists project-specific rules). - Skim
standards/docs/architecture/clean-architecture.mdfor layer boundaries. - Open
docs/domain/README.mdin the project repo for features and doc status. - Open the feature README and use case doc for the task you were assigned.
- Load Tier 1 Quick Rules from
agentLoadPlansinstandards/standards.manifest.json. Use the use case doclayer-contextfrontmatter when present (for examplebackend.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)
| Step | Where |
|---|---|
| Understand behavior | docs/domain/{feature}/{use-case}.md |
| Understand tests expected | docs/domain/{feature}/{use-case}.tests.md |
| Implement backend | Follow docs/guides/add-new-use-case.md and layer conventions |
| Implement frontend | Same guide; page composition doc under docs/ui/{app}/pages/ when applicable |
| Verify | Project commands in shim AGENTS.md; gates in standards/docs/conventions/shared/ci.md |
| Finish | standards/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
| Question | Document |
|---|---|
| Term definitions (Reactions, Spec sync rule, context tiers, tags) | standards/docs/glossary.md |
| All convention file paths | standards/standards.manifest.json → conventionIndex |
| Why a stack choice exists | standards/docs/decisions/README.md (humans; not routine agent load) |
| Copy-paste scaffolds | standards/docs/blueprints/README.md |
| Domain doc templates | standards/docs/templates/docs/ |
| CI and Docker templates | standards/docs/templates/config/ |
| Operations (deploy, rollback) | standards/docs/runbooks/README.md |
| Reference consumer monorepo | LitePress |
Common mistakes
- Treating
docs/domain/content as optional after the first sprint (docs drift causes wrong agent and human behavior). - Using
Guard.Againstin validators (maps to HTTP 500). Seedocs/conventions/backend/exception-hierarchy.md. - Injecting repositories into query handlers (use
IDatabaseContextonly). - Cross-feature imports in Next.js
features/folders. - Upgrading package versions without checking
standards.manifest.jsonpins.
Related documents
| Document | Audience |
|---|---|
README.md (standards repo root) | Submodule setup and versioning |
docs/README.md | Documentation map |
docs/guides/agentic-domain-driven-design.md | Domain documentation system |
docs/philosophy.md | Long-form rationale (optional read) |