Skip to main content

Skip docs navigation
manual page/ Reference

Cheatsheet

sourceSource: suspec/docs/reference/cheatsheet.mdModified: 2026-07-19

example.txt

file
intent -> spec -> implement -> review -> check -> findings

Use the least structure that changes execution or reviewability. Everything else is rent. See proportional rigor.

Artifacts

KindCarries
specintent and verifiable requirements
taskone scoped source slice
reviewrequirement assessments and evidence
inventoryobserved structure, behavior, tests, constraints, unknowns
change planbaseline, target, preservation, waves, rollback
auditevidenced present-state risks
researchevidence for one decision-informing question

Evidence receipts and run notes are untyped sidecars. Findings are not a type. Exact shapes: artifact formats.

Requirement

example.md

file
### AC-001 - Short name
- When: one concrete condition holds
- Then: the system MUST do one observable thing
- Verify with: `command`

Use one condition, one behavior, exactly one binding word, one verification, and no unresolved uncertainty.

Assessments

AssessmentMeaning
Supportedevidence demonstrates the requirement
Unsupportedevidence demonstrates failure
Unverifiedevidence is missing or insufficient
Blockeda dependency prevents judgment

Reverify after requirement text, commands, or exercised code changes.

Evidence

Use pasted command output, a visible labeled CI URL, or a named manual observation. tests passed proves only that someone typed tests passed.

Review attention

Expose unsupported, unverified, or blocked requirements; scope drift; excluded-area edits; risky or public interfaces; migrations; security-sensitive changes; missing output; findings; and blocked questions.

Check

command
suspec check <artifact> [<artifact>...]
suspec check <review-path> --spec <spec-path>
suspec check <review-path> --spec <spec-path> --task <task-path>
suspec check --contract

Multi-path checks add C002 duplicate-ID reconciliation. Exit 0 is clean, 1 warning, and 2 blocking. Multi-report --json output is JSON Lines. The checker reports facts; humans decide.

Need a starting point? Install the skills