Spec Studio

The Design Review shows an open question's key

spec:decisions.question-key-renderingDecision Record · featureready floor ready

Packs: pack:self-hosting-v1

Design: no design entries · no pinned declarations · no decisions

Findings: no errors, no warnings

specs/decisions/question-key-rendering.sdp.md

No open questions and no blocking questions; implementation binding none, verifier binding none, and expected-outcome oracle none.

Intent
outcome
Show an open question's key on its Spec page, so a reader can cite the question's entry address from the page.
Decision
context
spec:model.open-question-keys gives an open question an optional key in its marker and an entry address spec:<id>#question.<key>. The Design Review renders an open question as its escaped text, with the word blocking after a blocking one, and the shipped projections are frozen, so a reader of the page cannot see the key the address needs until a decision narrows the freeze for it. The first adopter cites its open questions from a decision register and from generated pages.
decision
The Design Review renders an open question that carries a key with the key as inline code, #<key>, at the start of its item, before the question's text; a question without a key renders as its text. The freeze on the four shipped projections stands for everything else.
rationale
  • The key is the one part of the address the page did not show, and the # that opens it in the marker opens it on the page.
alternatives
  • Rendering the whole address beside each question repeats the Spec id on every question of its own page.
  • Leaving the key off the page keeps the freeze whole and leaves the address to the carrier file and recipe 20.
Verification

Verifier bindings

No verifier binding recorded.

Design view

Requirement drawing

  • Declared verifying examples: no declared verifying example.
  • Satisfying or referencing units: no recorded binding.
  • Test or oracle bindings: no recorded binding.
Requirement drawing for spec:decisions.question-key-rendering

Arrows: refines (declared).

The diagram as text
  • spec:decisions.question-key-rendering: The Design Review shows an open question's key · declared Spec
  • spec:consumers.design-review: Design Review renders graph context without becoming a gate · declared Spec
  • spec:decisions.shipped-projections-frozen: The shipped projections stay frozen · declared Spec
  • spec:decisions.question-key-rendering refines spec:consumers.design-review · declared
  • spec:decisions.question-key-rendering refines spec:decisions.shipped-projections-frozen · declared — carves out one change, an open question's key shown before its text
Mermaid source

Copyable source; the Studio draws static SVG.

Preferred and chosen syntax: requirementDiagram; exact refines, satisfies and verifies, with claim words in nodes and per-edge comments.

Decisions

No decision record named.

Runtime

No implementation neighborhood recorded.

Runtime observation: not tracked.

Evidence

Runtime observation: not tracked.

Build attestations: not tracked.

Deployments: not tracked.

Bills of materials: not tracked.

Impact
Relations of spec:decisions.question-key-rendering
The diagram as text
  • spec:consumers.design-review: Design Review renders graph context without becoming a gate
  • spec:decisions.question-key-rendering: The Design Review shows an open question's key
  • spec:decisions.shipped-projections-frozen: The shipped projections stay frozen
  • spec:model.open-question-keys: An open question may carry a key that addresses it
  • spec:decisions.question-key-rendering dependsOn spec:model.open-question-keys · declared
  • spec:decisions.question-key-rendering refines spec:consumers.design-review · declared
  • spec:decisions.question-key-rendering refines spec:decisions.shipped-projections-frozen · declared — carves out one change, an open question's key shown before its text
  • spec:consumers.design-review decidedBy spec:decisions.question-key-rendering · declared — a keyed open question shows its key before its text
Mermaid source

Copyable source; the Studio draws static SVG.

Preferred syntax: flowchart. Chosen syntax: labelled flowchart, preserving exact relations, claims and folds.

Rests on

Rested on by

Distance 1

Distance 2

Distance 3

Distance 4

Distance 5

Distance 6

Distance 7

Relations

Relation and directionOther endClaimReasonExercised keys
dependsOn · outgoingAn open question may carry a key that addresses it
spec:model.open-question-keys · resolves		declaredNoneNone
refines · outgoingDesign Review renders graph context without becoming a gate
spec:consumers.design-review · resolves		declaredNoneNone
refines · outgoingThe shipped projections stay frozen
spec:decisions.shipped-projections-frozen · resolves		declaredcarves out one change, an open question's key shown before its textNone
decidedBy · incomingDesign Review renders graph context without becoming a gate
spec:consumers.design-review · resolves		declareda keyed open question shows its key before its textNone

Bindings

Implementation binding: none

Design reference: none

Verifier binding: none

Expected-outcome oracle: none

Runtime observation: not tracked.

Run results: not recorded in the graph.

Findings

None.

Composing (0)

Composing needs the script.