Files
Entropyk/.agent/skills/bmad-spec/assets/spec-template.md
sepehr 5bd180b5b8
Some checks failed
CI / check (push) Has been cancelled
Snapshot WIP: solver HP epic progress, BPHX/HX physics, BMAD skill refresh.
Capture uncommitted solver robustness work (regularization, domain errors, linear solver lifecycle, tube DP/MSH), web workbench updates, and synced BMAD skills across IDE agent folders before starting BPHX pressure-drop.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-19 16:35:31 +02:00

2.3 KiB

id, companions, sources
id companions sources
SPEC-{slug}

Canonical contract. This SPEC and the files in companions: are the complete, preservation-validated contract for what to build, test, and validate. Source documents listed in frontmatter are for traceability only — consult them only if you need narrative rationale or prose color this contract intentionally omits.

{Spec Title}

Why

{One paragraph naming the force behind this work. A spec can exist for any of:

  • a pain to solve — a user or operator is stuck on a specific gap;
  • an opportunity to capture — something newly possible we want to claim;
  • a vision to realize — a thing we want to make exist because we want it to exist;
  • a mandate to meet — a regulation, deprecation, deadline, or contractual obligation.

Name which (or which combination) applies, who is affected, and the backdrop that makes it matter now. This is the anchor every downstream trade-off resolves against.}

Capabilities

  • CAP-1
    • intent: {One sentence. "User or system can do X to achieve Y." WHAT, not HOW.}
    • success: {Testable or demonstrable criterion. Something a test or a real demonstration can decide.}

Constraints

  • {A non-negotiable that bends design. If it doesn't rule anything out, it doesn't belong.}

Non-goals

  • {Explicit out-of-scope item. At least one. Stops downstream from filling the vacuum.}

Success signal

  • {One or two sentences. World-change moment, not dashboard. Concrete enough to write a test or run a demonstration against.}

Assumptions

  • {Statement of fact the Spec proceeded under, e.g. "Assumed mobile-first since input mentioned GPS but no platform."}

Open Questions

  • {Question phrased so a human can answer it, e.g. "Is offline playback in scope for CAP-2?"}