STANDARDS
FACET builds on standards your team may already know.
FACET does not invent a notation where a good one exists. Scenarios read like Gherkin, ids follow the domain model, rules point at DMN, and every record is checked against JSON Schema.
Gherkin
A plain-language format that describes behaviour as concrete examples: Given a starting state, When something happens, Then an observable outcome.
IN FACET
Every scenario under contract.scenarios is a Given / When / Then statement, one scenario per rule or edge case, each step on its own line (FACET §3.2Original excerpt from the English source.
[…] The normative behavior of the feature — the rules that MUST hold. […]
View on GitHub). Cases of one rule become a Scenario Outline with examples tables (FACET §3.2.3Original excerpt from the English source.[…] MUST NOT flatten them into set notation or a list inside one Given/When/Then. […]
View on GitHub).Domain-Driven Design
An approach, named by Eric Evans in his book of the same name, that models software on the business domain and on the language of the people who know it.
IN FACET
Every id is domain/capability/feature, and the domain is a product domain, never a team or a service (FACET §2.2Original excerpt from the English source.
[…] Every feature has a canonical, stable identifier of the form: […]
View on GitHub). A taxonomy may class a domain or capability as core, supporting or generic, Evans' subdomains in his words (FACET §4.4.2Original excerpt from the English source.[…] it is orthogonal to depth. […]
View on GitHub). A glossary defines each term of art once (FACET §4.5Original excerpt from the English source.[…] Records are written in a product's own vocabulary, and a term of art appears in many of them […]
View on GitHub).DMN
Decision Model and Notation, the OMG standard for decision tables and business formulas.
IN FACET
contract.business_rules points at a decision or formula inside a .dmn file. The record holds the reference, never a copy of the logic (FACET §3.2.4Original excerpt from the English source.
[…] The business rules and formulas a feature applies […]
View on GitHub).JSON Schema
A vocabulary for describing and validating the shape of JSON and YAML documents.
IN FACET
Records, the taxonomy and the glossary are validated against draft-07 schemas. A record that fails its schema is a lint error (FACET §11.2Original excerpt from the English source.
[…] YAML record fails schema […]
View on GitHub).
Section numbers refer to the FACETOriginal excerpt from the English source.[…] a named, coherent capability of the product that can be reasoned about, changed, and owned independently. […]
View on GitHub.