Skip to main content

Module spec

Module spec 

Source
Expand description

Expectations, features and stories: what a suite says, after its text has been resolved against the vocabulary.

Structs§

ExpId
Expectation
Given some state, when something happens, then the system ends up in some state.
Fact
One resolved step: “the dial is above 55 %”.
Feature
FeatureId
Phrase
A step of your own, built from others: a higher-level way to say a setup or a sequence of actions, like “the user draws a triangle” for PEN, three clicks on the canvas and DONE. Specs read better and stay put when the details change; docs say it with say.
PhraseId
Scenario
Section
A group of features and stories that share a setup, nested like a book’s chapters: one per directory of the suite. Everything in a section starts from its start.
SectionId
StepText
A step as written, kept for docs and generated tests, with what it turned out to mean (none if it didn’t resolve) so docs can say it in the reader’s words.
Story
“As a tea drinker, I want …, so that …”, told through one or more scenarios.
StoryId
StoryStep
One “When …” of a story and the “Then …“s the story checks after it.
Suite
A whole suite: the vocabulary, its sections (the first is the root), and the expectations and stories written against them.
Term
Term: <name> and the text under it: a definition for the glossary.
Trigger
What sets an expectation off: an event, a change the outside world makes to some states, or both at once.

Enums§

Keyword
PhraseBody
Said
What a step says, once resolved.
Shift
A Then that’s relative to what was there before: “the drawing goes up by 1 item”, “the selected item stays the same”.