Skip to content

v0.1.0

Initial release of the SCALE framework specification and tooling.

What is SCALE?

SCALE is a machine-readable framework for telling the platform story: how engineering best practices are Standardized, Consumed, Automated, Leveraged, and made Effective across an organization. It is an aggregation and narrative layer over detailed maturity metrics — not another metrics catalog.

Features

Information Model

  • Framework → Domain → Capability → Metric hierarchy
  • Every metric tagged with exactly one SCALE aspect (S-C-A-L-E)
  • NarrativeBlocks (thesis, journey, outlook) attach at every level
  • DomainDimensions for ordered lifecycle stages (the domain's story spine)

Maturity Ladder

  • MaturityLadder maps observed values to PRISM maturity levels (1-5) mechanically
  • Supports threshold rungs, exclusive comparisons (>0%), and direction-aware comparisons
  • Weakest-link semantics: capability maturity = min(metric rungs), domain maturity = min(capability rungs)
  • "Not tracked" is a status (N/A), not a level — absence of measurement earns no rung

Rollup Aggregation

  • ComputeRollup calculates attainment per eligible metric (requires target + owner)
  • Domain aspect scores as plain means; overall scores as mean of domain scores
  • CompareRollups produces period-over-period deltas for the movers layer

External Model Support

  • ExternalModel codifies third-party maturity models (AWS, New Relic) as data
  • Source-faithful levels with provenance (sourceUrl, retrievedAt, interpretation)
  • PRISM crosswalks for level mapping
  • Reports render the ladder with current-practice markers

CLI (scale)

  • scale validate — validate catalog and assessments
  • scale report — render HTML story report (or -model <id> for external model lens)
  • scale export — assemble catalog to single JSON IR for web component

HTML Story Report

  • Self-contained HTML with light/dark themes, no external assets
  • Aspect tiles with period-over-period deltas
  • Movers section with per-metric attribution
  • Domain journeys with capability maturity chips
  • External model lens view

Web Component

  • <scale-report> Lit component renders the report client-side from JSON IR
  • compute.js mirrors Go rollup/maturity semantics (pinned by tests)
  • Themeable via --scale-* CSS custom properties
  • Embeddable in React, MkDocs, or plain HTML

Reference Catalog

Three domains seeded:

  • api — anchored by api-style-spec (rule coverage, conformance, SDKs)
  • observability — OTel adoption, Golden Signals, auto-instrumentation
  • security — AI-era security lifecycle as a worked dimension example

Two external models:

  • aws-observability-maturity — AWS Observability Maturity Model
  • newrelic-observability-maturity — New Relic Observability Maturity Model

Installation

go install github.com/ProductBuildersHQ/scale/cmd/scale@v0.1.0

Or as a library:

go get github.com/ProductBuildersHQ/scale@v0.1.0

What's Next

  • Catalog authoring guide
  • Additional domain examples
  • PRISM integration patterns