note (entity)

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

Schema version: 1.

Description

A Note is a freeform document that fits into the ontology: strict frontmatter (identity, genre, lifecycle, links) around a body with no required sections. Plans, research write-ups, analyses, strategy docs, retros — prose that is ours, written once, and wants identity and inbound links instead of living as a loose file.

A Note is not:

• A Reference. A Reference catalogs material SDLC did not write; a Note is our own writing.
• A Decision. A Decision records a choice with a fixed outcome section; a Note may argue toward one (genre: proposal) but carries no verdict.
• A Backlog item or Task. Those capture work to do; a Note captures thinking.

Properties

Field	Type	Required	Description
type	string	yes	Dispatch tag for the validator framework.
schema_version	string		Numeric 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).
id	string	yes	Immutable identifier per D-0002-entity-identifier-shape: ‘N-’ + 4 base-36 chars [0-9A-Z]. Matches the filename; never renamed once assigned.
state	string		Lifecycle stage. open/draft: being written (the default); open/active: current and leaned on; closed/superseded: replaced by the note in superseded_by; closed/archived: no longer current, kept for link stability.
title	string	yes	Human-readable headline. Frontmatter is canonical; the body opens with # <title> for readability.
created	string	yes	ISO date the entity was first authored.
last_reviewed	string		ISO date the entity was last reviewed. Optional: never in any per-type required set.
related	array		Cross-references. Entries are wikilinks — typically to entities by id (slug optional per D-0002-entity-identifier-shape), but may also reference non-entity planning docs by their wikilink slug.
tags	array		Free-form labels. Required at the common level, defaulting to []. Per-type schemas may add a contains constraint (e.g. Principle requires exactly one principle/<category> tag).
need_human_review	boolean		Review-tracking flag.
created_at	string		ISO 8601 timestamp the entity was authored, finer than created. Optional: stamped by tooling that authors entities, never required.
provenance	string		What 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.
status	string		OKF 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.
description	string
resource	string
stale_after	string
generated	object
verified	array
sources	array
usage_window	object
genre	string	yes	What kind of document this is. plan: sequenced intent to build something; research: findings gathered from sources; analysis: reasoning over data or code to reach a conclusion; strategy: direction and trade-offs at the product level; proposal: a change put forward for a decision; survey: a broad inventory of an area; retro: a look back at what happened; checklist: steps to tick through.
parent	string		Wikilink to the hub Note this one is a sub-document of. Slug is optional per D-0002-entity-identifier-shape.
superseded_by	string		Wikilink to the Note that replaces this one. Required when state is closed/superseded.

Enums

state

• open/draft
• open/active
• closed/superseded
• closed/archived

status

• draft
• stable
• deprecated

genre

• plan
• research
• analysis
• strategy
• proposal
• survey
• retro
• checklist