Skip to content

Developer

Overview

How the system is built: the endpoints, the structure standards, the database and identity rules, the running-service operations, and where the product direction is recorded.

Start with the domain, then the API. The same vocabulary is used on both sides, so a screen in Operator and its implementation are one click apart.

Access

No menu. This section is reached from Knowledge Base.

Screen

No screen.

Main Features

The Sections

Section What it covers
API Reference Every endpoint with its route, handler, caller and evidence
Architecture Structure standards, module registry, UI and runtime foundations, decision records
Domains Product, requirements, specifications and design
Database Where the schema and identity rules actually live
Integrations External providers and the boundaries around them
Operations Deploy, restore, recover — the runbooks
Development Documentation standard, test guidance, knowledge sources
Pages Engine specifications and prototypes

Where To Start For A Task

You are Start at
Changing a screen's behaviour Domains for the area, then the module in Architecture
Adding or changing an endpoint API Reference for the existing shape
Changing stored data or identity Database
Touching an external provider Integrations
Deploying or restoring Operations
Writing or updating documentation Development

The Vocabulary Is Shared

Operator Developer
Operator / Workflows / Billing / AR Billing Developer / API, Developer / Domains
Operator / Workflows / Purchase and Inbound Developer / API, Developer / Architecture
Operator / Processes Developer / Domains

Fields

Field What it means
Module The bounded unit that owns a capability
Route The endpoint path and method
Owner The single semantic owner of a record or command

Status

There is no status on this section.

Documentation here describes the live system. If a document and the running system disagree, that is a defect in the document — report it rather than trusting it.

Notes

  • The API reference is generated from the source. If it disagrees with the code, the code is right and the reference needs regenerating.
  • Read the structure standard before adding a file, module or boundary. See System Structure Standard.
  • Operations material is separated from development material on purpose. A runbook is executed under pressure; an architecture document is read calmly.
  • Decisions and investigations are not here — see History and Archive.