Skip to main content
manual page/ Reference

Principles

sourceSource: suspec/docs/reference/principles.mdModified: 2026-06-30
Sections
7
Format
Markdown
Order
33 / 156

These rules resolve conflicts in the docs and templates.

No runtime in this repo

This repo is markdown and documentation.

Tool behavior described here is a contract for optional tooling, not proof that this repo runs it.

Use precise wording:

  • good: suspec check can report...
  • bad: Suspec enforces...

Conventions are not enforcement

Every rule has an honesty level:

  • convention
  • checklist
  • toolable
  • enforced

This docs repo enforces nothing.

Teams can enforce rules in CI or hooks. That is the team's gate.

Code can falsify intent, not amend it

Specs and decisions state intent.

Code and tests show reality.

When they disagree:

  • re-run evidence
  • amend the spec
  • fix the code

Do not let changed code silently redefine the requirement.

Evidence beats shape

A valid-looking file is not evidence.

A Pass needs:

  • pasted output
  • CI link
  • named manual observation

Empty evidence means Unverified.

Provider neutral

Suspec artifacts are plain markdown.

They must work with any agent or human who can read files.

Do not make one provider's behavior a framework requirement.

Claims need sources

Load-bearing empirical claims cite docs/research/sources.md.

If a claim has no source, label it as design rationale or remove it.

Rejected sources are not cited.

Starter kit: Set up a workspace