Literate Modeling

Term

Literate Modeling

Aliases

-

Identity

  • Term ID: src/main/doxsite/glossary/literate-modeling/literate-modeling.dox

  • English label: Literate Modeling

  • Japanese label: 文芸モデリング

  • Scope qualifier: SimpleModeling / activity and method for constructing Literate Models

  • Bare-label linking: linkable

  • Category: Literate Modeling

  • Status: normative

  • Definition authority: SimpleModeling BoK

DEFINITION

Literate Modeling is the activity and method of describing subjects, purposes, situations, requirements, decisions, scenarios, intent, assumptions, history, and related information primarily in natural language and in an order and form people can understand, and organizing it as a Literate Model with explicit meanings, identities, and mappings to other Model elements.

Origin

The term extends to modeling the idea of Donald E. Knuth’s Literate Programming: treating a program and its explanation in one document and presenting them in an order that supports human understanding. Literate Modeling denotes the activity and method; a Literate Model denotes the subject and result described and organized through that activity.

SimpleModeling

In SimpleModeling, Literate Modeling relates natural-language information to Object and Knowledge Models and shares it among human developers, non-developers, and generative AI. Its important subjects include not only purpose-specific documents such as Vision statements and Use Cases, but also conventional documents that explain Domain Model concepts, rules, and relationships in natural language. An important use is supplying Use Case Scenarios directly to generative AI and connecting AI-proposed mappings to executable Models after human review and approval.

CML

A CML (Cozy Modeling Language) document is a concrete practice of Literate Modeling because its formal elements express an executable Object Model while natural-language explanation, intent, and assumptions in the same document express Literate Model content. A complete Literate Model is not expected to be expressed in CML.

Boundary

  • Accumulating natural-language documents alone is not Literate Modeling.

  • Literate Modeling is not the work of attaching explanation to a formal Model afterward.

  • Literate Modeling and a Literate Model are not synonymous; the former is an activity and method, while the latter is its subject and result.

  • Literate Model

  • Literate Programming

  • Story

  • Narrative

  • Use Case Scenario

  • SmartDox

  • CML

References

  • src/main/doxsite/development-process/literate-modeling.dox

  • src/main/doxsite/glossary/literate-modeling/literate-model.dox

  • docs/spec/glossary-entry-format.md