Skip to main content

DomainDocs4S

Generate domain documentation from Scala code

"org.business4s" %% "domaindocs4s-collector" % "unreleased"

Annotate

Domain concepts are documented directly in Scala code using annotations and compile-time information. This ensures that documentation stays close to the source of truth and never goes out of sync.

Collect

Documentation data is collected from TASTy files using a semantic model of symbols and their relationships, allowing precise extraction of domain structure without relying on brittle source parsing.

Generate

Collected domain metadata can be transformed into human-readable documentation formats, making complex domain models understandable to both developers and non-technical stakeholders.