Skip to content

Domain Documentation Index

Domain Documentation Index

Living map of the system. Update this file when a feature or use case is added, renamed, or retired.


Features

FeatureAggregate(s)Use casesDoc status
postsPostcreate-post, publish-post, list-postsComplete
authorsAuthorregister-authorTests doc missing

Doc status vocabulary:

StatusMeaning
CompleteOperation doc and test spec exist and match current behavior
Tests doc missingOperation doc exists; {use-case}.tests.md not yet written
DraftDocs exist; use case not fully implemented
DeprecatedUse case retired; docs kept for history

Cross-Domain Notes

Document shared concepts that span domain features here (for example authentication model, tenancy, pagination defaults). Prefer defining terms in the feature README that owns the concept and linking from here.


Conventions

  • Feature README: docs/domain/{feature}/README.md
  • Operation doc: docs/domain/{feature}/{use-case}.md (kebab-case)
  • Test spec: docs/domain/{feature}/{use-case}.tests.md
  • Update domain docs in the same PR as the code they describe (Spec sync rule).

See standards/docs/guides/agentic-domain-driven-design.md and standards/docs/guides/write-use-case-doc.md.

Agents: maintain docs/domain/agent-index.json when features or use cases change.