Skip to content

Establish a formal language-theoretic schema for IDD specification formats #24

@slusset

Description

@slusset

Summary

The IDD spec format currently evolves through documentation, examples, and validator behavior, but it does not yet have a single normative schema that defines which artifact forms are legal and how they compose.

This creates ambiguity when introducing richer representations such as:

  • annotated journey references
  • lifecycle/state-machine shorthand
  • aggregate-root model documents
  • catalog/registry documents
  • shared value-object bundles

Problem

Today, format evaluation is operational rather than fully formal:

  • docs/idd/front-matter-spec.md defines part of the shape
  • validators enforce parts of the format
  • examples demonstrate accepted forms
  • certification verifies traceability and evidence

That is useful, but it means the canonical language is partly implicit in tool behavior. As the spec surface expands, that increases the risk of drift between documentation, examples, and validators.

Desired outcome

Define a formal language-theoretic schema for IDD specifications so that:

  • each artifact kind has a normative grammar or meta-schema
  • allowed document families are explicit rather than inferred
  • validator behavior is derived from the documented schema
  • examples act as acceptance fixtures rather than de facto standards
  • new spec forms can be evaluated against a published extension model

Scope

This issue should establish the schema approach, not necessarily complete every validator rewrite in one pass.

In scope:

  • decide the formalism to use for each artifact class
  • document canonical forms for narrative, model, contract, and traceability metadata
  • define how extensions are introduced without breaking compatibility
  • identify which current formats are normative, legacy-compatible, or experimental
  • define conformance levels for docs, examples, validators, and certification

Out of scope:

  • redesigning the entire IDD methodology
  • changing downstream implementation skills unless needed for schema conformance

Acceptance criteria

  • A normative schema document exists for IDD artifact formats.
  • The schema distinguishes canonical, legacy-compatible, and experimental forms.
  • Model documents explicitly cover entity, value object, aggregate, catalog, bundle, and lifecycle/state-machine forms.
  • Traceability metadata rules explicitly cover annotated references where supported.
  • Validator responsibilities are mapped to the schema rather than relying on undocumented assumptions.
  • Example fixtures are identified as conformance fixtures for the schema.
  • A migration strategy exists for evolving formats without breaking existing adopters.

Why this matters

Without a formal schema, tool behavior becomes the effective standard. That slows evolution, makes validator bugs harder to classify, and makes it unclear whether a new representation is invalid, unsupported, or simply undocumented.

A formal schema would let IDD evolve intentionally instead of extemporaneously.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions