Skip to main content
Version: 0.4

guardrails

A guardrail is a rule that limits what a specification can say, so that what it does say is precise enough to regenerate software from and testable enough to trust. Each guardrail is meant to be enforced: either the renderer rejects a specification that breaks it, or the generated tests check that the implementation honors it.

∗∗∗plain specifications are written in natural language inside these guardrails. This section describes each of them.

The guardrails​

  • Basic syntax - a .plain file has fixed sections, and each kind of knowledge belongs in exactly one of them
  • Definitions - every concept is defined before it is used, and every concept name is unique
  • Implementation reqs - decisions about how the software is built are stated as constraints the agent must follow
  • Test reqs - how conformance tests are built and run is stated, not what the tests check
  • Functional specs - each one describes a single behavior and is small enough to regenerate reliably
  • Test scenarios - every functionality carries its own test scenarios, and the renderer generates exactly those tests
  • Modules - a specification can be split into several .plain files that are rendered together, and each kind of module may contain only certain sections

Supporting pages​

Additional resources​