Skip to content
StartupBuilderby Startups.Studio
Code
Changelog
File conventionsProductsProducts

Product definition

A Product definition names what a Customer gets and references its Nouns by id, so one Noun serves many Products.

PropertyValue
Pathproducts/[product].mdx
HoldsProduct
Kindfile
Leadersdb-first, git-first
TeamProduct Team
Written byChange.merge
Compiled bySoftwareBuilder

Example

products/monthly-close.mdx in a Startup repository. Closewise, a sample business, declares a Close Noun.

products/monthly-close.mdx
---
$type: [Service, API]
nouns: [Close]
verbs: [Close.reconcile, Close.close]
---
Books done within three business days of month end, tied out to the bank.

Props

The frontmatter keys the file takes. The body is its prose.

PropTypeRequiredDescription
nounslist of NounThe Nouns it exposes, by id. Nouns stay at the root, so two Products share one.
verbsstring[]The Verbs it exposes, by id.
interfaceslist of InterfaceThe Interfaces it serves on.
roleRoleFor an Agent, the Role in agents/ it fills.

Generates

SoftwareBuilder compiles it into these records, Verbs and routes.

KindWhat
RecordsProduct, Interface
VerbsNone.
Routes/{ns}/{nouns}