Skip to content

principle (entity)

Generated from solutions/ontological/lib/model/entities/principle/schema.ts.

Schema version: 2.

A Principle is a broad value the project leans on for design judgment. Principles are upstream of Standards: a Principle says what is valued (“prefer deterministic over LLM when possible”); a Standard says how that value lands as a scoped rule on specific paths.

A Principle is not:

  • A Standard (Standards enforce; Principles guide).
  • A Rule. It is a value that lets the project reason about edge cases — including when not to apply it.
FieldTypeRequiredDescription
typestringyesDispatch tag for the validator framework.
schema_versionstringNumeric string version of the per-type schema this instance conforms to. Compare numerically when ordering versions. Independent of any product version. The value 0 is a documented sentinel meaning ‘pre-SDLC-managed’ — audit treats it as intentional, not stale. Optional in frontmatter: never in any per-type required set (audit flags a MISSING stamp as drift, not the validator).
idstringyesImmutable identifier in canonical P-NNNN shape per D-0002-entity-identifier-shape: ‘P-’ + 4 zero-padded chars [0-9A-Z] (Principles use incrementing numbering). Never renamed once assigned.
statestringLifecycle stage. open/* states are active; closed/* are terminal. open/draft: actively being authored; open/published: stable for downstream reference; closed/retired: the principle no longer drives design judgment but is retained for historical reference.
titlestringyesHuman-readable headline. Frontmatter is canonical; the body opens with # <title> for readability.
createdstringyesISO date the entity was first authored.
last_reviewedstringISO date the entity was last reviewed. Optional: never in any per-type required set.
relatedarrayCross-references to other principles or standards. Slug is optional per D-0002-entity-identifier-shape.
tagsarrayFree-form labels. MUST include exactly one principle/ tag (product | technical | project | llm-ai). Per-type extension of the common tags field, adding the contains/minContains/maxContains constraint.
need_human_reviewbooleanReview-tracking flag.
created_atstringISO 8601 timestamp the entity was authored, finer than created. Optional: stamped by tooling that authors entities, never required.
provenancestringWhat authored the entity when it was not written by hand: a skill invocation, tool, or import source (e.g. sdlc:capability-map packages/ts). Optional: absent means hand-authored.
statusstringOKF v0.2’s own document-maturity key — DISTINCT from the entity’s own lifecycle state field (do not confuse the two). Optional: absent means OKF makes no maturity claim about this document.
descriptionstring
resourcestring
stale_afterstring
generatedobject
verifiedarray
sourcesarray
usage_windowobject
  • open/draft
  • open/published
  • closed/retired
  • draft
  • stable
  • deprecated